Autentikointi on sama kuin kaikissa Public-Api-pyynnöissä.
Varaston tuote päivitykset voidaan lähettää WMS:stä nShift Returniin. Jos nShift Returnissa on käsittelemättömiä palautuksia, niitä voidaan päivittää /wms-update POST-pyynnön kautta.
Päätepiste
URL: POST/public-api/v3/wms-update
Päätepiste tarjoaa (toistaiseksi) mahdollisuuden käsitellä palautuksia automaattisesti palautustilauksille, jotka on luotu järjestelmäämme ja joiden tila on Käsittelemätön.
| Parametri | Tyyppi | Pakollinen | Kommentit |
| forwardOrderId | String | Kyllä | Alkuperäisen eteenpäinlähetetyn tilauksen muuttumaton tunniste, joka lähetettiin kuluttajalle. |
| returnId | String | Kyllä | Tunnistaa tämän tuotteen vastaavan palautustilauksen. |
| updatedAt | Päivämäärä | Kyllä | Aikaleima, jolloin tietuetta on viimeksi päivitetty. |
| alternativeOrderIds | Taulukko | Ei | Vaihtoehtoisten tilaus-ID:iden taulukko, joilla tätä eteenpäinlähetettyä tilausta voidaan tunnistaa. |
| marketCode | String | Ei | Kauppiaan määrittelemä valmiiksi konfiguroitu markkinatunniste. |
| currency | String | Ei | |
| itemCount | Integer | Kyllä | Palautuksen tuotteiden lukumäärä. |
| items | Taulukko | Kyllä | Palautukseen sisältyvien tuotteiden taulukko. Katso alla oleva formaattikuvaus. |
| forwardOrderItemId | String | Kyllä | Tuotteen tunniste alkuperäisessä tilauksessa. |
| returnItemId | String | Ei | Jos saatavilla, tunnistaa tämän palautustuotteen muissa kauppiaan järjestelmissä. |
| sku | String | Kyllä | Tuotevariantin SKU |
| productId | String | Ei | Tuotteen muuttumaton tunniste. Käytetään ristivertailuihin. |
| productVariantId | String | Ei | Tuotevariantin muuttumaton tunniste. Käytetään ristivertailuihin. |
| isPresent | Boolean | Ei | Käytetään vain, jos WMS voi kertoa, että tietyn tuotteen odotettiin olevan palautuksessa, mutta sitä ei todellisuudessa ollut. |
| isAccepted | Boolean | Kyllä | Ilmaisee, voidaanko tietty tuote hyväksyä palautettavaksi ja se tulee hyvittää. |
| returnReasonCode | String | Ei | Kauppiaan antama merkkijonokoodi, joka kuvaa palautuksen syyn (esim. jos pakkauksessa on täytetty palautuslomake). |
| returnConditionCode | String | Ei | Kauppiaan antama merkkijonokoodi, joka kuvaa tuotteen kunnon vastaanotettaessa. |
| netAmount | Double | Kyllä | Hyvityksen määrä ilman välillisiä veroja (esim. ALV tai myyntivero). |
| taxAmount | Double | Kyllä | Tämän tuotteen hyvitettyjen välillisten verojen määrä. |
| grossAmount | Double | Kyllä | Hyvityksen määrä välilliset verot mukaan lukien (esim. ALV tai myyntivero). |
Esimerkkipyyntö:
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, jos pyyntö onnistui.
Virhekoodit tarvittaessa.
Esimerkiksi, jos pyyntö on virheellinen:
{
"code": 400,
"error": "Bad Request",
"message": "Something went wrong",
"timestamp": "2023-02-22T07:50:24Z"
}
Tällä hetkellä ainoa toimiva prosessi on palautustilauksen päivittäminen tilaan Käsitelty, jos palautus on jo luotu järjestelmäämme mutta ei ole Käsitelty/Hyväksytty. Palautuksen tulee sisältää täsmälleen sama määrä tuotteita kuin vastaanotetussa pyynnössä.