Log ind

nShift Help Center

WMS API

Avatar
Malene Tidemann
Opdateret

Autentificering er den samme som for alle Public-Api forespørgsler.

Lageropdateringer kan sendes fra WMS til nShift Return. Hvis der er ubehandlede returneringer i nShift Return, kan disse opdateres via /wms-update POST-forespørgslen.


Endpoint

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

Endpoint giver mulighed (for nu) for automatisk behandling af returneringer for returneringsordrer, der er oprettet i vores system og er i status Ikke Behandlet.

 

ParameterTypePåkrævetKommentarer
forwardOrderIdStringJaEt uforanderligt ID for den oprindelige fremadgående ordre, som blev sendt til forbrugeren.
returnIdStringJaIdentificerer den returneringsordre, som denne vare svarer til.
updatedAtDatoJaTidsstempel for hvornår posten sidst blev opdateret.
alternativeOrderIdsArrayNejEt array af alternative ordre-ID'er, som denne fremadgående ordre muligvis kan identificeres ved.
marketCodeStringNejEn forudkonfigureret markedsidentifikator defineret af forhandleren.
currencyStringNej 
itemCountIntegerJaAntallet af varer i denne returnering.
itemsArrayJaEt array af returneringsvarer inkluderet i denne opdatering.
Se nedenfor for formatdetaljer.
forwardOrderItemIdStringJaVare-ID inden for den oprindelige ordre.
returnItemIdStringNejHvis tilgængeligt, identificerer denne returneringsvare i andre forhandlersystemer.
skuStringJaProduktvariant SKU
productIdStringNejUforanderligt ID for produktet. Bruges til krydstjek.
productVariantIdStringNejUforanderligt ID for produktvarianten. Bruges til krydstjek.
isPresentBooleanNejBruges kun hvis WMS kan oplyse, at en bestemt vare forventedes at være i returneringen, men faktisk ikke var der.
isAcceptedBooleanJaAngiver om en bestemt vare kan accepteres til returnering og skal refunderes.
returnReasonCodeStringNejForhandler-leveret strengkode, der beskriver returneringsårsagen (f.eks. hvis der er en udfyldt returneringsformular i pakken).
returnConditionCodeStringNejForhandler-leveret strengkode, der beskriver varens tilstand ved modtagelse.
netAmountDoubleJaBeløbet der skal refunderes eksklusive indirekte skatter (f.eks. moms eller salgsskat).
taxAmountDoubleJaBeløbet af indirekte skatter, der refunderes for denne vare.
grossAmountDoubleJaBeløbet der skal refunderes inklusive indirekte skatter (f.eks. moms eller salgsskat).

 

Eksempel på forespørgsel:

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 hvis forespørgslen gennemføres succesfuldt.
Fejlkoder hvor relevant.
For eksempel, hvis der er dårlig input i forespørgslen:

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

 

På nuværende tidspunkt er den eneste flow, der fungerer, opdatering af en returneringsordre til Behandlet, hvis returneringen allerede er oprettet i vores system, men ikke Behandlet/Godkendt. Returneringen skal indeholde det præcise antal varer som modtaget i forespørgslen.

 

Relaterede artikler