Logg på

nShift Help Center

Push API

Avatar
Malene Tidemann
Oppdatert

Autentisering

På samme måte som Pull API, bruker Push API Basic Authentication. Informasjonen som kreves består av brukernavn og passord for din organisasjon (bilde som viser brukstilfellet fra Postman nedenfor).

 

returns-authentication.png

 

Endepunkter

Ordre

1.1. Push ordrer konsolidert

Tidligere har API-et støttet individuelle endepunkter for å pushe ordrer, kunder og produkter. Å ha et enkelt endepunkt for å pushe hele strukturen sikrer bedre datakonsistens, og gjør det også enklere for kunden å pushe hele nyttelasten, i stedet for å utføre separate kall for de nødvendige entitetene.

Formålet med endepunktet er å pushe ordrer (inkludert kunde- og produktdata) som deretter kan returneres av kunder i Returportalen basert på returpolicyen satt opp i portalen.

 

URL: POST /push-orders-consolidated

 

Push ordre Test miljø:

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

 

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

 

Parametre:

Det finnes ingen spørringsstreng- eller URL-parametre, men metoden krever at kalleren sender et array av PushOrderConsolidated-modeller i kroppen av forespørselen.
De egenskapene som er mulige i input JSON er detaljert nedenfor, delt opp etter sub-objektene de representerer:

 

Eksempel på kall:

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

 

 

For en oppdatert liste over felter og API-informasjon, vennligst se vår tekniske dokumentasjon her.


 

Ordre-objekt:

Egenskap Type Påkrevd Tilleggsinformasjon
orderId string Ja  
alternativeOrderIds string[] Nei  
marketCode string Ja Brukes for å spesifisere ønsket marked for den gitte ordren. Returplattformen støtter flere markeder (når det trengs forskjellige valutaer osv.)
currency string Nei  
customer Kunde Ja Modell beskrevet nedenfor
createdAt DatoTid (ISO-format) Nei Fylles automatisk med nåværende DatoTid hvis ikke sendt inn
updatedAt DatoTid (ISO-format) Nei Fylles automatisk med nåværende DatoTid hvis ikke sendt inn
netTotal desimal Nei Netto kostnad for ordren
taxTotal desimal Nei Skattebeløp for ordren
grossTotal desimal Nei Beløp på ordren inkludert skatt
items OrderItem[] Ja Modell detaljert nedenfor
shipmentDate DatoTid (ISO-format) Nei Dato for utsendelse
shippingCostTotal desimal Nei Brukes ved refusjon av fraktkostnad
shippingAddress Adresse Nei Modell detaljert nedenfor
invoiceExternalId string Nei Ekstern ID for fakturaen hvis du trenger en spesiell ID registrert sammen med ordren
isHidden boolean Nei Standard til false
isNonReturnable boolean Nei Standard til false (hvis true gjør alle ordrelinjer ikke-returable)
isPending boolean Nei Brukes for å sette ordren i en ventende tilstand, noe som betyr at den ikke er fullstendig behandlet ennå, så den er ikke tilgjengelig for retur før dette settes til false.
isCancelled boolean Nei Flagg for å indikere at ordren er kansellert og ingen retur er tillatt.

 

Order Item-objekt:

Egenskap Type Påkrevd Tilleggsinformasjon
orderItemId string Nei Identifikator for ordrelinje i ekstern e-handelsløsning
nonReturnable boolean Nei

→ hvis ordre-nivå nonReturnable er satt til true, blir dette videreført til alle OrderItems

→ egenskapen på OrderItem-nivå kan brukes for å sette kun spesifikke varer i ordren som ikke-returable
netAmount desimal Nei Netto kostnad for ordrelinjen
taxAmount desimal Nei Skattebeløp for ordrelinjen
grossAmount desimal Nei Beløp for ordrelinjen inkludert skatt
statusOfDelivery string/enum Ja Mulige verdier er: “DELIVERED”, “PENDING”. Verdien som settes her avgjør om varen kan returneres, kun varer som allerede er “DELIVERED” kan returneres.
quantity int Nei Settes automatisk til 1 hvis ikke spesifisert, må være en verdi >1 og <99
hsCode string Nei  
countryOfOrigin string Nei  
customsDescription string Nei Beskrivelse som brukes til tollklarering
ean string Nei  
productVariant ProductVariant Ja Modell detaljert nedenfor

 

ProductVariant-objekt:

Egenskap Type Påkrevd Tilleggsinformasjon
thumbnailImage string Nei URL til bilde som skal vises som miniatyr for den respektive produktvarianten
images string[] Nei Array av bilder karakteristiske for produktvarianten
name string Nei Menneskelig lesbart navn på produktvarianten
sku string Nei Identifikator for den spesifikke produktvarianten i ekstern e-handelsløsning
attributes Dictionary<string, string> Nei Ordbok som inneholder nøkkel-verdi-par, med “name” og “value”, med attributter som beskriver produktvarianten
ean string Nei  
harmCode string Nei  
countryOfOrigin string Nei  
weightValue double Nei Vektverdi for produktvarianten
weightUnits string Nei Måleenhet for vekten (som kg)
customsArticleDescription string Nei Beskrivelse av det gitte produktet som sendes ved booking med transportører når det er grensekryssende og tollinformasjon er nødvendig.
variantId string Nei Variant-ID i ekstern e-handelsløsning
productId string Nei  
productName string Ja Navn på produktvarianten
productSku string Nei SKU på produktet
productDescription string Nei  

 

Kunde-objekt:

Egenskap Type Påkrevd Tilleggsinformasjon
customerId string Ja Identifikator for kunde i ekstern e-handelsløsning
firstName string Nei  
lastName string Nei  
email string Nei  
phoneNumber string Nei  
locale string Nei  
deliveryAddress Adresse Nei Modell detaljert nedenfor
createdAt DatoTid (ISO-format) Nei Fylles automatisk med nåværende DatoTid hvis ikke sendt inn
updatedAt DatoTid (ISO-format) Nei Fylles automatisk med nåværende DatoTid hvis ikke sendt inn

 

Adresse-objekt:

Egenskap Type Påkrevd Tilleggsinformasjon
name string Nei  
streetAddress string Ja  
city string Nei  
state string Nei  
country string Nei Fylles ut fra countryAlpha2 på ordre-nivå hvis tom på adresse-nivå
postalCode string Nei  

 

 

Relaterte artikler