MarkAsPaid

La chiamata MarkAsPaid ha la seguente firma:

OrderMarkAsPaidResponse MarkAsPaid(OrderMarkAsPaidRequest request);

Cosa permette di fare

La chiamata MarkAsPaid permette di modificare lo stato di pagamento di un insieme determinato di ordini referenziato dai relativi ID eDock. Tale operazione non è annullabile: un ordine marcato come pagato non è più ritrattabile.

Limitazioni

  • Un ordine marcato come pagato, rimane tale per sempre. Tale operazione non è modificabile per cui va eseguita con la massima attenzione.

Richiesta

In rosso sono evidenziate le proprietà obbligatorie.

 Proprietà  Tipo  Descrizione
 OrderId  Guid[]  Array degli ID degli ordini che si vogliono spostare.

 

Risposta

 Proprietà  Tipo  Descrizione
 MarkAsPaidReport  OrderMarkAsPaidResultEntry[]  Contenitore delle report di pagamento ordini
 MarkAsPaidReport.OrderMarkAsPaidResultEntry  OrderMarkAsPaidResultEntry  Contenitore di un singolo report di pagamento
 MarkAsPaidReport.OrderMarkAsPaidResultEntry.OrderId  Guid  ID Ordine a cui si riferisce il report
 MarkAsPaidReport.OrderMarkAsPaidResultEntry.Success  Bool  Indica se il pagamento è andato a buon termine o meno.
 ErrorCode  String  Codice errore
 ErrorMessage  String  Messaggio d'errore
 Status  Status  Enumerativo che rappresenta lo stato di esecuzione della chiamata. Valori ammessi:
  • Success: la chiamata è stata eseguita senza errori.
  • Warning: la chiamata è stata eseguita per alcuni prodotti, ma non per tutti.
  • Error: la chiamata non è stata eseguita per nessun prodotto.

Errori possibili

 ErrorCode  
 Significato
 AUTH0001  Impossibile autenticare l'utente. Il nome utente o i token non sono validi o non sono corretti. 
 ORDERPAY001  L'array dei GUID degli ordini passato è nullo.
 ORDERPAY002  L'array dei GUID degli ordini passati è vuoto.

 

Esempio richiesta XML

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/" xmlns:edoc="http://schemas.datacontract.org/2004/07/eDock.Api.Classes" xmlns:edoc1="http://schemas.datacontract.org/2004/07/eDock.Api.Classes.Order" xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
   <soapenv:Header/>
   <soapenv:Body>
      <tem:MarkAsPaid>
         <tem:filter>
            <edoc:ApiToken>[il vostro token eDock]</edoc:ApiToken>
            <edoc:Culture>it-IT</edoc:Culture>
            <edoc:Type>Normal</edoc:Type>
            <edoc:eDockUsername>[il vostro nome utente eDock]</edoc:eDockUsername>
            <edoc1:OrderId>
               <!--Una o più ripetizioni:-->
               <arr:guid>7500fc52-90bc-42a1-b574-78629e6a3f13</arr:guid>
            </edoc1:OrderId>
         </tem:filter>
      </tem:MarkAsPaid>
   </soapenv:Body>
</soapenv:Envelope>
Altre domande? Invia una richiesta

Commenti