Aanmelden

nShift Help Center

WMS API

Avatar
Malene Tidemann
Bijgewerkt

Authenticatie is hetzelfde als voor alle Public-Api verzoeken.

Voorraaditemupdates kunnen vanuit WMS naar nShift Return worden gestuurd. In het geval dat er onverwerkte retouren zijn in nShift Return, kunnen deze worden bijgewerkt via het /wms-update post verzoek.


Endpoint

URL: POST/public-api/v3/wms-update

Het endpoint biedt (voor nu) de mogelijkheid om retouren automatisch te verwerken voor retourorders die in ons systeem zijn aangemaakt en de status Niet Verwerkt hebben.

 

ParameterTypeVereistOpmerkingen
forwardOrderIdStringJaEen onveranderlijke ID van de originele doorstuurorder, die naar de consument is gestuurd.
returnIdStringJaIdentificeert de retourorder waar dit item bij hoort.
updatedAtDatumJaTijdstempel wanneer het record voor het laatst is bijgewerkt.
alternativeOrderIdsArrayNeeEen array van alternatieve order-ID's waaronder deze doorstuurorder mogelijk bekend is.
marketCodeStringNeeEen vooraf geconfigureerde marktidentificatie gedefinieerd door de handelaar.
currencyStringNee 
itemCountIntegerJaHet aantal items in deze retour.
itemsArrayJaEen array van retouritems die in deze update zijn opgenomen.
Zie hieronder voor details over het formaat.
forwardOrderItemIdStringJaItem-ID binnen de originele order.
returnItemIdStringNeeIndien beschikbaar, identificeert dit retouritem in andere handelaarssystemen.
skuStringJaProductvariant SKU
productIdStringNeeOnveranderlijke ID van het product. Wordt gebruikt voor controles.
productVariantIdStringNeeOnveranderlijke ID van de productvariant. Wordt gebruikt voor controles.
isPresentBooleanNeeWordt alleen gebruikt als het WMS kan aangeven dat een bepaald item verwacht werd in de retour, maar feitelijk niet aanwezig was.
isAcceptedBooleanJaGeeft aan of een bepaald item geaccepteerd kan worden voor retour en terugbetaald moet worden.
returnReasonCodeStringNeeDoor de handelaar verstrekte stringcode, die de reden voor de retour beschrijft (bijvoorbeeld als er een ingevuld retourformulier in het pakket zit).
returnConditionCodeStringNeeDoor de handelaar verstrekte stringcode, die de staat van het item bij ontvangst beschrijft.
netAmountDoubleJaHet bedrag dat terugbetaald moet worden exclusief indirecte belastingen (bijv. BTW of omzetbelasting).
taxAmountDoubleJaHet bedrag aan indirecte belastingen dat voor dit item wordt terugbetaald.
grossAmountDoubleJaHet bedrag dat terugbetaald moet worden inclusief indirecte belastingen (bijv. BTW of omzetbelasting).

 

Voorbeeldverzoek:

Post https://staging.returnado.com/public-api/v3/wms-update

 

{
  "returns": [
    {
      "marketCode": "JPN",
      "forwardOrderId": "20230221435",
      "updatedAt": "2023-02-20T12:34:56Z",
      "altForwardOrderIds": [
        {
          "type": "magentoId",
          "value": "10000254585"
        },
        {
          "type": "receiptReference",
          "value": "2255682775117751"
        }
      ],
      "returnId": "20230221435",
      "currency": "SEK",
      "itemCount": 1,
      "items": [
        {
          "forwardOrderItemId": "1",
          "returnItemId": "2023",
          "productId": "2023",
          "productVariantId": "hera",
          "sku": "hera",
          "quantity": 1,
          "isPresent": true,
          "isAccepted": true,
          "returnReasonCode": "BAD_FIT",
          "returnConditionCode": "NOT_USED",
          "netAmount": 39.00,
          "taxAmount": 0.00,
          "grossAmount": 39.00
        },
        {
          "forwardOrderItemId": "1",
          "returnItemId": "2024",
          "productId": "2024",
          "productVariantId": "heras",
          "sku": "heras",
          "quantity": 1,
          "isPresent": true,
          "isAccepted": true,
          "returnReasonCode": "BAD_FIT",
          "returnConditionCode": "NOT_USED",
          "netAmount": 39.00,
          "taxAmount": 0.00,
          "grossAmount": 39.00
        }
      ]
    }
  ]
}

 

HTTP 200 als het verzoek succesvol is afgerond.
Foutcodes waar van toepassing.
Bijvoorbeeld, bij een onjuist verzoek:

{
    "code": 400,
    "error": "Bad Request",
    "message": "Something went wrong",
    "timestamp": "2023-02-22T07:50:24Z"
}

 

Op dit moment werkt alleen de flow waarbij een retourorder wordt bijgewerkt naar Verwerkt, als de retour al in ons systeem is aangemaakt maar niet Verwerkt/Goedgekeurd is. De retour moet het exacte aantal items bevatten zoals in het ontvangen verzoek.

 

Verwante artikelen