Push API – nShift Help Center

Autentisering

Likt Pull API använder Push API Basic Authentication. Den information som krävs består av användarnamn och lösenord för din organisation (bild som visar användningsfallet från Postman nedan).

Endpoints

Order

1.1. Push orders consolidated

Tidigare har API:et stödjat separata endpoints för att pusha order, kunder och produkter. Att ha en enda endpoint för att pusha hela strukturen säkerställer bättre datakonsistens, vilket också gör det enklare för kunden att pusha hela payloaden istället för att göra separata anrop för de olika entiteterna.

Syftet med endpointen är att pusha order (inklusive kund- och produktdata) som sedan kan hanteras vidare av kunder i Returportalen baserat på returpolicy som är inställd i portalen.

URL: POST /push-orders-consolidated

Push order Test miljö:

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

Push order Prod-miljö:
https://new-prod.returnado.com/public-api/v3/push-api/push-orders-consolidated

Parametrar:

Det finns inga query string- eller URL-parametrar, men metoden kräver att anroparen skickar en array av PushOrderConsolidated-modeller i begärans kropp.
Egenskaperna som är möjliga i indata JSON beskrivs nedan, uppdelade efter de underobjekt de representerar:

Exempel på anrop:

Request Body:

[
    {
        "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"
            }
        }
    }
  ]

För en uppdaterad lista över fält och API-information, se vår tekniska dokumentation här.

Orderobjekt:

Egenskap	Typ	Krävs	Ytterligare information
orderId	string	Ja
alternativeOrderIds	string[]	Nej
marketCode	string	Ja	Används för att specificera önskad marknad för given order. Returns-plattformen stödjer flera marknader (vid behov av olika valutor etc.)
currency	string	Nej
customer	Kund	Ja	Modell beskriven nedan
createdAt	DateTime (ISO-format)	Nej	Fylls i automatiskt med aktuell tid om inte skickad
updatedAt	DateTime (ISO-format)	Nej	Fylls i automatiskt med aktuell tid om inte skickad
netTotal	decimal	Nej	Netto kostnad för ordern
taxTotal	decimal	Nej	Skattebelopp för ordern
grossTotal	decimal	Nej	Orderbelopp inklusive skatt
items	OrderItem[]	Ja	Modell detaljerad nedan
shipmentDate	DateTime (ISO-format)	Nej	Datum för leverans
shippingCostTotal	decimal	Nej	Används vid återbetalning av fraktkostnad
shippingAddress	Adress	Nej	Modell detaljerad nedan
invoiceExternalId	string	Nej	Extern id för fakturan om du behöver ett särskilt id registrerat tillsammans med ordern
isHidden	boolean	Nej	Standardvärde är false
isNonReturnable	boolean	Nej	Standardvärde är false (om true gör alla orderrader icke-returnerbara)
isPending	boolean	Nej	Används för att sätta ordern i vänteläge, vilket innebär att den inte är helt behandlad och därför inte kan returneras förrän detta sätts till false.
isCancelled	boolean	Nej	Flagga som indikerar att ordern är avbokad och ingen retur är tillåten.

Orderradsobjekt:

Egenskap	Typ	Krävs	Ytterligare information
orderItemId	string	Nej	Identifierare för orderrad i externt e-handelssystem
nonReturnable	boolean	Nej	→ om ordernivåns nonReturnable är satt till true, sprids detta till alla orderrader → egenskapen på orderradsnivå kan användas för att enbart sätta specifika rader som icke-returnerbara
netAmount	decimal	Nej	Netto kostnad för orderraden
taxAmount	decimal	Nej	Skattebelopp för orderraden
grossAmount	decimal	Nej	Belopp för orderraden inklusive skatt
statusOfDelivery	string/enum	Ja	Möjliga värden är: “DELIVERED”, “PENDING”. Värdet avgör om varan kan returneras, endast varor som är “DELIVERED” kan returneras.
quantity	int	Nej	Sätts automatiskt till 1 om inget anges, måste vara ett värde >1 och <99
hsCode	string	Nej
countryOfOrigin	string	Nej
customsDescription	string	Nej	Beskrivning som används för tullklarering
ean	string	Nej
productVariant	ProductVariant	Ja	Modell detaljerad nedan

Produktvariantobjekt:

Egenskap	Typ	Krävs	Ytterligare information
thumbnailImage	string	Nej	URL till bild som ska visas som miniatyr för respektive produktvariant
images	string[]	Nej	Array av bilder som är karaktäristiska för produktvarianten
name	string	Nej	Mänskligt läsbart namn för produktvarianten
sku	string	Nej	Identifierare för den specifika produktvarianten i det externa e-handelssystemet
attributes	Dictionary<string, string>	Nej	Ordbok innehållande nyckel-värde-par med “name” och “value”, med attribut som beskriver produktvarianten
ean	string	Nej
harmCode	string	Nej
countryOfOrigin	string	Nej
weightValue	double	Nej	Värde för produktvariantens vikt
weightUnits	string	Nej	Måttenhet för vikten (t.ex. kg)
customsArticleDescription	string	Nej	Beskrivning av produkten som skickas med bokning hos transportörer vid gränsöverskridande och tullinformation behövs.
variantId	string	Nej	Variant-id i det externa e-handelssystemet
productId	string	Nej
productName	string	Ja	Namn på produktvarianten
productSku	string	Nej	SKU för produkten
productDescription	string	Nej

Kundobjekt:

Egenskap	Typ	Krävs	Ytterligare information
customerId	string	Ja	Identifierare för kund i externt e-handelssystem
firstName	string	Nej
lastName	string	Nej
email	string	Nej
phoneNumber	string	Nej
locale	string	Nej
deliveryAddress	Adress	Nej	Modell detaljerad nedan
createdAt	DateTime (ISO-format)	Nej	Fylls i automatiskt med aktuell tid om inte skickad
updatedAt	DateTime (ISO-format)	Nej	Fylls i automatiskt med aktuell tid om inte skickad

Adressobjekt:

Egenskap	Typ	Krävs	Ytterligare information
name	string	Nej
streetAddress	string	Ja
city	string	Nej
state	string	Nej
country	string	Nej	Fylls i från countryAlpha2 på ordernivå om tom på adressnivå
postalCode	string	Nej

nShift Help Center