Autentisering er den samme som for alle Public-Api-forespørsler.
Lageroppdateringer kan sendes fra WMS til nShift Return. Dersom det finnes ubehandlede returer i nShift Return, kan disse oppdateres via /wms-update POST-forespørselen.
Endepunkt
URL: POST/public-api/v3/wms-update
Endepunktet gir mulighet (foreløpig) til å behandle returer automatisk for returordrer som er opprettet i vårt system og som har status Ikke behandlet.
| Parameter | Type | Påkrevd | Kommentarer |
| forwardOrderId | String | Ja | En uforanderlig ID for den opprinnelige fremoverordren som ble sendt til forbrukeren. |
| returnId | String | Ja | Identifiserer returordren dette elementet gjelder. |
| updatedAt | Dato | Ja | Tidsstempel for når posten sist ble oppdatert. |
| alternativeOrderIds | Array | Nei | En liste med alternative ordre-IDer som denne fremoverordren kan identifiseres med. |
| marketCode | String | Nei | En forhåndskonfigurert markedsidentifikator definert av selgeren. |
| currency | String | Nei | |
| itemCount | Integer | Ja | Antall varer i denne returen. |
| items | Array | Ja | En liste med returvarer inkludert i denne oppdateringen. Se nedenfor for formatdetaljer. |
| forwardOrderItemId | String | Ja | Vare-ID innenfor den opprinnelige ordren. |
| returnItemId | String | Nei | Hvis tilgjengelig, identifiserer denne returvaren i andre selgersystemer. |
| sku | String | Ja | Produktvariantens SKU |
| productId | String | Nei | Uforanderlig ID for produktet. Brukes for krysskontroller. |
| productVariantId | String | Nei | Uforanderlig ID for produktvarianten. Brukes for krysskontroller. |
| isPresent | Boolean | Nei | Brukes bare hvis WMS kan angi at en bestemt vare var forventet i returen, men faktisk ikke var der. |
| isAccepted | Boolean | Ja | Angir om en bestemt vare kan aksepteres for retur og skal refunderes. |
| returnReasonCode | String | Nei | Selger-tilbydd strengkode som beskriver returårsak (for eksempel hvis det finnes et utfylt returskjema i pakken). |
| returnConditionCode | String | Nei | Selger-tilbydd strengkode som beskriver varens tilstand ved mottak. |
| netAmount | Double | Ja | Beløpet som skal refunderes ekskludert indirekte skatter (f.eks. MVA eller salgsskatt). |
| taxAmount | Double | Ja | Beløpet for indirekte skatter som refunderes for denne varen. |
| grossAmount | Double | Ja | Beløpet som skal refunderes inkludert indirekte skatter (f.eks. MVA eller salgsskatt). |
Eksempel på forespørsel:
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ørselen fullføres uten feil.
Feilkoder der det er relevant.
For eksempel ved ugyldig input-forespørsel:
{
"code": 400,
"error": "Bad Request",
"message": "Something went wrong",
"timestamp": "2023-02-22T07:50:24Z"
}
For øyeblikket er den eneste flyten som fungerer, å oppdatere en returordre til Behandlet dersom returen allerede er opprettet i vårt system, men ikke Behandlet/Godkjent. Returen må inneholde nøyaktig antall varer som forespørselen mottok.