Webservice‎ > ‎Order API‎ > ‎

Move

La chiamata Move ha la seguente firma:

OrderMoveResponse Move(OrderMoveRequest request);

Cosa permette di fare

La chiamata Move permette di spostare uno o più ordini in un nuovo stato. Precisiamo che è possibile spostare, nell'arco di un mese, un numero massimo di ordini nuovi (cioè mai spostati) pari al numero di ordini gestibili al mese da contratto eDock. Oltre a tale numero gli ordini non possono essere più spostati. Per poter spostare un ordine è necessario conoscere il nome dello stato verso cui si desidera spostare. Ricordiamo che esistono 4 stati predefiniti in eDock: Acquistato, Spedito, Ricevuto e Chiuso. Ogni ordine ricevuto si trova nello stato Acquistato. Ogni cliente eDock può creare un numero indeterminato di stati, ma attualmente non esiste un modo per creare stati attraverso le API: è necessario che il cliente li configuri tramite la diretta interfaccia di eDock.

Limitazioni

  • Gli stati verso cui devono essere spostati gli ordini devono essere già esistenti.

Richiesta

In rosso sono evidenziate le proprietà obbligatorie.

 Proprietà Tipo Descrizione
 ApplyCommunicationFlows Bool Attualmente ignorato
 MoveToStatus String Stato verso cui si vuole muovere gli ordini
 OrderId Guid[] Array degli ID degli ordini che si vogliono spostare.

Risposta

 Proprietà Tipo Descrizione
 MoveReport OrderMoveResponseEntry[] Contenitore delle report di movimentazione di ordini
 MoveReport.OrderMoveResponseEntry OrderMoveResponseEntry Contenitore di un singolo report di movimentazione
 MoveReport.OrderMoveResponseEntry.OrderId Guid ID Ordine a cui si riferisce il report
 MoveReport.OrderMoveResponseEntry.Success Bool Indica se il movimento è 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.
 ORDERMOVE001 L'array degli ID ordine da spostare è nullo.
 ORDERMOVE002 L'array degli ID ordine da spostare è 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:Move>
         <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:ApplyCommunicationFlows>false</edoc1:ApplyCommunicationFlows>

            <edoc1:MoveToStatus>Spedito</edoc1:MoveToStatus>
            <edoc1:OrderId>
               <arr:guid>7500fc52-90bc-42a1-b574-78629e6a3f13</arr:guid>
            </edoc1:OrderId>
         </tem:filter>
      </tem:Move>
   </soapenv:Body>
</soapenv:Envelope>