Autentisering är densamma som för alla Public-Api-förfrågningar.
Lageruppdateringar kan skickas från WMS till nShift Return. Om det finns obehandlade returer i nShift Return kan dessa uppdateras via /wms-update post-förfrågan.
Endpoint
URL: POST/public-api/v3/wms-update
Endpoint ger (för tillfället) möjlighet att automatiskt behandla returer för returorder som har skapats i vårt system och är i status Ej behandlad.
| Parameter | Typ | Obligatorisk | Kommentarer |
| forwardOrderId | String | Ja | En oföränderlig ID för den ursprungliga forwardordern, som skickades till konsumenten. |
| returnId | String | Ja | Identifierar returordern som denna post motsvarar. |
| updatedAt | Datum | Ja | Tidsstämpel när posten senast uppdaterades. |
| alternativeOrderIds | Array | Nej | En lista med alternativa order-ID:n som denna forwardorder kan identifieras med. |
| marketCode | String | Nej | En förkonfigurerad marknadsidentifierare definierad av handlaren. |
| currency | String | Nej | |
| itemCount | Heltal | Ja | Antal artiklar i denna retur. |
| items | Array | Ja | En lista med returartiklar som ingår i denna uppdatering. Se nedan för formatdetaljer. |
| forwardOrderItemId | String | Ja | Artikel-ID inom den ursprungliga ordern. |
| returnItemId | String | Nej | Om tillgängligt, identifierar denna returartikel i andra handlarssystem. |
| sku | String | Ja | Produktvariantens SKU |
| productId | String | Nej | Oföränderligt ID för produkten. Används för korskontroller. |
| productVariantId | String | Nej | Oföränderligt ID för produktvarianten. Används för korskontroller. |
| isPresent | Boolean | Nej | Används endast om WMS kan avgöra att en viss artikel förväntades finnas i returen men faktiskt inte gjorde det. |
| isAccepted | Boolean | Ja | Indikerar om en viss artikel kan accepteras för retur och ska återbetalas. |
| returnReasonCode | String | Nej | Handlarens angivna strängkod som beskriver returorsak (till exempel om det finns ett ifyllt returformulär i paketet). |
| returnConditionCode | String | Nej | Handlarens angivna strängkod som beskriver artikelns skick vid mottagandet. |
| netAmount | Double | Ja | Beloppet som ska återbetalas exklusive indirekta skatter (t.ex. moms eller försäljningsskatt). |
| taxAmount | Double | Ja | Beloppet av indirekta skatter som återbetalas för denna artikel. |
| grossAmount | Double | Ja | Beloppet som ska återbetalas inklusive indirekta skatter (t.ex. moms eller försäljningsskatt). |
Exempel på förfrågan:
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 om förfrågan slutfördes framgångsrikt.
Fel-koder där det är lämpligt.
Till exempel vid dålig indata:
{
"code": 400,
"error": "Bad Request",
"message": "Something went wrong",
"timestamp": "2023-02-22T07:50:24Z"
}
För närvarande är det enda flödet som fungerar att uppdatera en returorder till Behandlad om returen redan är skapad i vårt system men inte Behandlad/Godkänd. Returen måste innehålla exakt samma antal artiklar som i den mottagna förfrågan.