Autentificering

Ligesom Pull API'en bruger Push API'en Basic Authentication. De nødvendige oplysninger består af brugernavn og adgangskode til din organisation (billedet nedenfor viser brugsscenariet fra Postman).

 

Endepunkter

Ordrer

1.1. Push ordrer konsolideret

Tidligere har API'en understøttet individuelle endepunkter til at pushe ordrer, kunder og produkter. At have et enkelt endepunkt til at pushe hele strukturen sikrer bedre datakonsistens og gør det også nemmere for kunden at pushe hele payloaden i stedet for at foretage separate kald for de nødvendige enheder.

Formålet med endepunktet er at pushe ordrer (inklusive kunde- og produktdata), som derefter kan returneres af kunder i Returneringsportalen baseret på returpolitikopsætningen 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:

Der er ingen query string eller URL-parametre, men metoden kræver, at kaldende part sender et array af PushOrderConsolidated-modeller i anmodningens body.
De egenskaber, der er mulige i input JSON, er detaljeret nedenfor, opdelt efter de underobjekter, de repræsenterer:

 

Eksempel på kald:

Anmodningsbody:

[
    {
        "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 opdateret liste over felter og API-information, se venligst vores tekniske dokumentation her.


 

Ordreobjekt:

Ordrelinjeobjekt:

Produktvariantobjekt:

Kundeobjekt:

Adresseobjekt: