Authenticatie

Net als bij de Pull API maakt de Push API gebruik van Basic Authentication. De benodigde informatie bestaat uit de gebruikersnaam en het wachtwoord voor uw organisatie (afbeelding hieronder toont het gebruiksscenario vanuit Postman).

 

Endpoints

Bestellingen

1.1. Push bestellingen geconsolideerd

In het verleden ondersteunde de API afzonderlijke endpoints voor het pushen van bestellingen, klanten en producten. Het hebben van één enkel endpoint voor het pushen van de volledige structuur zorgt voor betere dataconsistentie, en maakt het ook eenvoudiger voor de klant om de volledige payload te pushen in plaats van afzonderlijke oproepen te doen voor de benodigde entiteiten.

Het doel van het endpoint is om bestellingen (inclusief klant- en productgegevens) te pushen die vervolgens verder kunnen worden teruggegeven door klanten in het Retourportaal op basis van het retourbeleid dat in het portaal is ingesteld.

 

URL: POST /push-orders-consolidated

 

Push bestelling Test omgeving:

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

Push bestelling Prod omgeving:
https://new-prod.returnado.com/public-api/v3/push-api/push-orders-consolidated

 

Parameters:

Er zijn geen query string- of URL-parameters, maar de methode vereist dat de aanroeper een array van PushOrderConsolidated modellen in de body van het verzoek meestuurt.
De eigenschappen die mogelijk zijn in de input JSON worden hieronder gedetailleerd, verdeeld per sub-object waarvoor ze representatief zijn:

 

Voorbeeld oproep:

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

Voor een actuele lijst van velden en API-informatie, zie onze technische documentatie hier.


 

Bestelobject:

Order Item object:

ProductVariant object:

Klantobject:

Adresobject: