Kirjaudu sisään

nShift Help Center

Push API

Avatar
Malene Tidemann
Päivitetty

Todennus

Samoin kuin Pull API, Push API käyttää Basic Authentication -menetelmää. Tarvittavat tiedot koostuvat organisaatiosi käyttäjätunnuksesta ja salasanasta (alla oleva kuva näyttää käyttötapauksen Postmanista).

 

returns-authentication.png

 

Päätepisteet

Tilaukset

1.1. Yhdistettyjen tilausten push

Aikaisemmin API on tukenut erillisiä päätepisteitä tilausten, asiakkaiden ja tuotteiden pushaamiseen. Yhden päätepisteen käyttäminen koko rakenteen pushaamiseen varmistaa paremman tietojen yhdenmukaisuuden, ja se tekee myös asiakkaalle helpommaksi lähettää koko tietosisältö kerralla sen sijaan, että tekisi erillisiä kutsuja tarvittaville entiteeteille.

Päätepisteen tarkoituksena on puskea tilaukset (mukaan lukien asiakas- ja tuotetiedot), jotka asiakkaat voivat sitten palauttaa Palautusportaalissa portaalin palautuskäytännön mukaisesti.

 

URL: POST /push-orders-consolidated

 

Push-tilaus Testi ympäristö:

https://staging.returnado.com/public-api/v3/push-api/push-orders-consolidated

 

Push-tilaus Tuotanto-ympäristö:
https://new-prod.returnado.com/public-api/v3/push-api/push-orders-consolidated

 

Parametrit:

Kyselymerkkijono- tai URL-parametreja ei ole, mutta menetelmä vaatii kutsujalta PushOrderConsolidated-mallien taulukon lähettämisen pyynnön rungossa.
Syöte-JSON:n ominaisuudet on kuvattu alla, jaoteltuna alikohteittain, joita ne edustavat:

 

Esimerkkikutsu:

Pyyntörunko:

[
    {
        "orderId": "mircea-test-2",
        "marketCode": "root",
        "currency": "SEK",
        "customerId": "bc-test-customer-1",
        "createdAt": "2023-01-20T18:54:11.627+01:00[UTC]",
        "updatedAt": "2023-01-22T18:54:11.627+01:00[UTC]",
        "netTotal": 27,
        "taxTotal": 5,
        "grossTotal": 32.0,
        "items": [
            {
                "orderItemId": "sku-1",
                "nonReturnable": false,
                "netAmount": 8.5,
                "taxAmount": 2.5,
                "grossAmount": 11.0,
                "statusOfDelivery": "DELIVERED",
                "countryOfOrigin": "USA",
                "productVariant": {
                    "thumbnailImage": "http://123.com/image.1.jpg",
                    "images": [],
                    "name": "Sofa ordinary in red color",
                    "sku": "sofa-1-2-3",
                    "attributes": [
                        {
                            "name": "size",
                            "value": "XL"
                        },
                        {
                            "name": "color",
                            "value": "red"
                        }
                    ],
                    "ean": "1233578",
                    "harmCode": "09887676",
                    "countryOfOrigin": "USA",
                    "weightValue": 24,
                    "weightUnits": "kg",
                    "customsArticleDescription": "a huge nice red sofa",
                    "variantId": "internal-variant-id-1",
                    "productId": "sofa-1-2-3",
                    "productName": "Sofa ordinary",
                    "productSku": "sofa-1-2",
                    "productDescription": "Sofa ordinary"
                }
            }
        ],
        "customer": {
            "customerId": "bc-test-customer-1",
            "firstName": "John",
            "lastName": "Doe",
            "email": "mircea@test.com",
            "phoneNumber": "+1000",
            "locale": "en",
            "deliveryAddress": {
                "name": "John Doe",
                "streetAddress": "Street 1 4",
                "city": "Big Apple",
                "state": "Massa",
                "country": "Happyville",
                "postalCode": "12345"
            }
        }
    }
  ]

 

 

Ajantasaisen kenttäluettelon ja API-tiedot löydät teknisestä dokumentaatiostamme täältä.


 

Tilaus-objekti:

Ominaisuus Tyyppi Pakollinen Lisätiedot
orderId string Kyllä  
alternativeOrderIds string[] Ei  
marketCode string Kyllä Käytetään määrittämään haluttu markkina kyseiselle tilaukselle. Palautusalusta tukee useita markkinoita (tarvittaessa eri valuutoilla jne.)
currency string Ei  
customer Asiakas Kyllä Kuvaus alla
createdAt DateTime (ISO-muoto) Ei Täytetään automaattisesti nykyisellä DateTimella, jos ei lähetetä
updatedAt DateTime (ISO-muoto) Ei Täytetään automaattisesti nykyisellä DateTimella, jos ei lähetetä
netTotal desimaali Ei Tilauksen nettokustannus
taxTotal desimaali Ei Tilauksen veromäärä
grossTotal desimaali Ei Tilauksen summa veroineen
items OrderItem[] Kyllä Kuvaus alla
shipmentDate DateTime (ISO-muoto) Ei Toimituspäivä
shippingCostTotal desimaali Ei Käytetään, kun palautetaan toimituskuluja
shippingAddress Osoite Ei Kuvaus alla
invoiceExternalId string Ei Laskun ulkoinen tunniste, jos tarvitset erityisen tunnisteen rekisteröityvän tilauksen yhteyteen
isHidden boolean Ei Oletusarvo false
isNonReturnable boolean Ei Oletusarvo false (jos true, tekee kaikista tilauksen tuotteista palautumattomia)
isPending boolean Ei Käytetään asettamaan tilaus odottavaan tilaan, mikä tarkoittaa, että sitä ei ole vielä täysin käsitelty, eikä sitä voi palauttaa ennen kuin tämä asetetaan falseksi.
isCancelled boolean Ei Merkki siitä, että tilaus on peruutettu eikä palautusta sallita.

 

Tilaustuote-objekti:

Ominaisuus Tyyppi Pakollinen Lisätiedot
orderItemId string Ei Tilaustuotteen tunniste ulkoisessa verkkokauppajärjestelmässä
nonReturnable boolean Ei

→ jos tilauksen tasolla nonReturnable on asetettu trueksi, se periytyy kaikille tilauksen tuotteille

→ tilauskohtainen ominaisuus voidaan asettaa vain tiettyjen tuotteiden palautumattomiksi
netAmount desimaali Ei Tilaustuotteen nettokustannus
taxAmount desimaali Ei Tilaustuotteen veromäärä
grossAmount desimaali Ei Tilaustuotteen summa veroineen
statusOfDelivery string/enum Kyllä Mahdolliset arvot: “DELIVERED”, “PENDING”. Tämän arvon perusteella määritetään, voidaanko tuotetta palauttaa; vain tuotteet, jotka ovat jo “DELIVERED”-tilassa, voidaan palauttaa.
quantity int Ei Asetetaan automaattisesti arvoksi 1, jos ei määritetty. Arvon tulee olla 1 ja
hsCode string Ei  
countryOfOrigin string Ei  
customsDescription string Ei Kuvaus tulliselvitystä varten
ean string Ei  
productVariant ProductVariant Kyllä Kuvaus alla

 

ProductVariant-objekti:

Ominaisuus Tyyppi Pakollinen Lisätiedot
thumbnailImage string Ei URL kuvaan, joka näytetään pikkukuvana kyseiselle tuotevariantille
images string[] Ei Taulukko tuotevariantille ominaisista kuvista
name string Ei Tuotevariantin ihmislukuinen nimi
sku string Ei Tuotevariantin tunniste ulkoisessa verkkokauppajärjestelmässä
attributes Dictionary<string, string> Ei Sanakirja, joka sisältää avain-arvo -pareja, joissa on “name” ja “value”, kuvaamassa tuotevariantin ominaisuuksia
ean string Ei  
harmCode string Ei  
countryOfOrigin string Ei  
weightValue double Ei Tuotevariantin painon arvo
weightUnits string Ei Painon mittayksikkö (esim. kg)
customsArticleDescription string Ei Kuvaus tuotteesta, joka lähetetään kuljetusyhtiöille rajat ylittävissä lähetyksissä tullitietoja varten.
variantId string Ei Variantin tunniste ulkoisessa verkkokauppajärjestelmässä
productId string Ei  
productName string Kyllä Tuotevariantin nimi
productSku string Ei Tuotteen SKU
productDescription string Ei  

 

Asiakas-objekti:

Ominaisuus Tyyppi Pakollinen Lisätiedot
customerId string Kyllä Asiakkaan tunniste ulkoisessa verkkokauppajärjestelmässä
firstName string Ei  
lastName string Ei  
email string Ei  
phoneNumber string Ei  
locale string Ei  
deliveryAddress Osoite Ei Kuvaus alla
createdAt DateTime (ISO-muoto) Ei Täytetään automaattisesti nykyisellä DateTimella, jos ei lähetetä
updatedAt DateTime (ISO-muoto) Ei Täytetään automaattisesti nykyisellä DateTimella, jos ei lähetetä

 

Osoite-objekti:

Ominaisuus Tyyppi Pakollinen Lisätiedot
name string Ei  
streetAddress string Kyllä  
city string Ei  
state string Ei  
country string Ei Täytetään tilauksen countryAlpha2-arvosta, jos osoitetasolla tyhjä
postalCode string Ei  

 

 

Aiheeseen liittyvät artikkelit