Orders API

Orders API Documentation

Introduction

Overview

The EuroStocks Orders-API is an interface to provide information and Manage orders.

Main Features

  • Orders List

  • Order Details

  • Update ProcessedByIntegrator flag

  • Update Order Status (Archive or Trash)

  • Update Order to Previous Status

  • Refund for Specific Order

Prerequisites

Orders API access can be granted to suppliers who wants to get information and Manage Orders, and it requires username, password and API Key to access API.

Limited support for the development process and maintenance:

Please note that all examples provided in our documentation are considered as guidelines for your development process but EuroStocks for itself is not able to directly assist with any of your preferred programming languages and/or used scripts.

Test Account

A test environment can be provided. Please ask for the test account details and all the information will be used as mention in Prerequisites on test API Base URL: https://test-orders-api.eurostocks.com/

Working with Orders API

Get Orders list

GET /api/v1/order/list/{orderStatus}/{paymentStatus}/{sortOrder}/{pageNumber}/{pageSize}/{processedByIntegrator}/{fromDate}/{toDate}/{search}

Request Parameters

Name
Type
Description

orderStatus*

String

Status of the Order

paymentStatus*

String

Status of the Payment

sortOrder*

String

Sorting Order of the list

pageNumber*

Integer

Page Number of the list

pageSize*

Integer

Page Size of the list

processedByIntegrator

Boolean

Processed By Integrator Flag. Value of flag, it can be either “true” or “false”.

fromDate

String

From Date for Orders

toDate

String

To Date for Orders

search

String

Search text in the list

Headers

Name
Type
Description

UserName*

String

Username which EuroStocks provides

Password*

String

Password which EuroStocks provides

APIKey*

String

APIKey which EuroStocks provides

Sample Success Request

GET
https://orders-api.eurostocks.com/api/v1/order/list/OrderStatus_New/PaymentStatus_Paid/SortOrder_Desc/1/5

Sample Success Response

Note: All the DateTime in below response is in 24-hour UTC format

HTTP/1.1 200 OK
{
    "orders": [
        {
            "orderId": 2512095,
            "orderStatus": "OrderStatus_New",
            "orderDateTime": "2025-12-05T05:32:02.653Z",
            "totalItemsOrdered": 1,
            "orderAmount": 15,
            "orderCurrency": "EUR",
            "paymentStatus": "PaymentStatus_Paid",
            "paymentInitiated": true,
            "paymentExpired": false,
            "processedByIntegrator": false,
            "customerType": "CustomerType_Guest",
            "salutation": "Salutation_Mr",
            "customerName": "Ad Vermeulen",
            "customerEmail": "[email protected]",
            "orderSource": "www.dekkermotorparts.com"
        },
        {
            "orderId": 2512072,
            "orderStatus": "OrderStatus_New",
            "orderDateTime": "2025-12-04T23:35:25.303Z",
            "totalItemsOrdered": 1,
            "orderAmount": 119.5,
            "orderCurrency": "EUR",
            "paymentStatus": "PaymentStatus_Paid",
            "paymentInitiated": true,
            "paymentExpired": false,
            "processedByIntegrator": false,
            "customerType": "CustomerType_Registered",
            "salutation": "Salutation_Mr",
            "customerName": "leon de Bruijn",
            "customerEmail": "[email protected]",
            "orderSource": "www.mercedes-spareparts.com"
        },
        {
            "orderId": 2512049,
            "orderStatus": "OrderStatus_New",
            "orderDateTime": "2025-12-04T23:22:32.713Z",
            "totalItemsOrdered": 1,
            "orderAmount": 59.9,
            "orderCurrency": "EUR",
            "paymentStatus": "PaymentStatus_Paid",
            "paymentInitiated": true,
            "paymentExpired": false,
            "processedByIntegrator": false,
            "customerType": "CustomerType_Guest",
            "salutation": "Salutation_Mr",
            "customerName": "Karam badawi",
            "customerEmail": "[email protected]",
            "orderSource": "www.topautoparts.nl"
        },
        {
            "orderId": 2511980,
            "orderStatus": "OrderStatus_New",
            "orderDateTime": "2025-12-04T22:30:20.250Z",
            "totalItemsOrdered": 1,
            "orderAmount": 210.01,
            "orderCurrency": "EUR",
            "paymentStatus": "PaymentStatus_Paid",
            "paymentInitiated": true,
            "paymentExpired": false,
            "processedByIntegrator": false,
            "customerType": "CustomerType_Guest",
            "salutation": "Salutation_Mr",
            "customerName": "Donny  Van den Burgt",
            "customerEmail": "[email protected]",
            "orderSource": "www.vasonderdelen.nl"
        },
        {
            "orderId": 2511971,
            "orderStatus": "OrderStatus_New",
            "orderDateTime": "2025-12-04T22:23:03.967Z",
            "totalItemsOrdered": 1,
            "orderAmount": 86,
            "orderCurrency": "EUR",
            "paymentStatus": "PaymentStatus_Paid",
            "paymentInitiated": true,
            "paymentExpired": false,
            "processedByIntegrator": false,
            "customerType": "CustomerType_Guest",
            "salutation": "Salutation_Mr",
            "customerName": "Tom van de meulenreek",
            "customerEmail": "[email protected]",
            "orderSource": "www.autoonderdelenveghel.nl"
        }
    ],
    "totalPages": 8872,
    "totalRows": 44356,
    "currentPageNumber": 1
}

Get Order Details

GET /api/v1/order/details/{orderId}/{languageISOCode}

Request Parameters

Name
Type
Description

orderId*

Integer

Id of the Order (required).

languageISOCode*

String

ISO Code of the language for which you want to fetch the data (required).

Headers

Name
Type
Description

UserName*

String

Username which EuroStocks provides

Password*

String

Password which EuroStocks provides

APIKey*

String

ApiKey which EuroStocks provides

Sample Success Request

GET
https://orders-api.eurostocks.com/api/v1/order/details/1488616/nl

Sample Success Response

Note: All the DateTime in below response is in 24-hour UTC format

HTTP/1.1 200 OK
{
  "orderId": 1488616,
  "location": "Renoir Parts B.V.",
  "orderDateTime": "2023-07-21T11:44:04.893Z",
  "orderMedium": "Desktop",
  "orderAmount": 1012.49,
  "orderCurrency": "EUR",
  "shippingType": "Verzenden",
  "shippingCost": 13.49,
  "paymentMethod": "ideal",
  "paymentCost": 0,
  "paymentStatus": "PaymentStatus_Paid",
  "orderConfirmationEmailSent": true,
  "orderSource": "directautos.eu",
  "comments": {
    "customerComment": "",
    "internalComment": ""
  },
  "refunds": [],
  "items": [
    {
      "itemId": 991070,
      "itemType": "ItemType_Product",
      "itemTitle": "Test Product NL",
      "warehouseLocation": "Location test",
      "margin": "no",
      "status": "ProductStatus_Published",
      "quantity": 1,
      "unitPrice": 999,
      "totalPrice": 999,
      "images": [
        {
          "size": "small",
          "url": "https://test-cdn.eurostocks.nl/cdn/w=small?fp=https://test-images.eurostocks.com/0/b558d4b39b214812/webshop/products/991070/xxlarge/test-product-nl-ot0khfry.jpg"
        },
        {
          "size": "medium",
          "url": "https://test-cdn.eurostocks.nl/cdn/w=medium?fp=https://test-images.eurostocks.com/0/b558d4b39b214812/webshop/products/991070/xxlarge/test-product-nl-ot0khfry.jpg"
        },
        {
          "size": "large",
          "url": "https://test-cdn.eurostocks.nl/cdn/w=large?fp=https://test-images.eurostocks.com/0/b558d4b39b214812/webshop/products/991070/xxlarge/test-product-nl-ot0khfry.jpg"
        },
        {
          "size": "xlarge",
          "url": "https://test-cdn.eurostocks.nl/cdn/w=xlarge?fp=https://test-images.eurostocks.com/0/b558d4b39b214812/webshop/products/991070/xxlarge/test-product-nl-ot0khfry.jpg"
        },
        {
          "size": "xxlarge",
          "url": "https://test-cdn.eurostocks.nl/cdn/w=xxlarge?fp=https://test-images.eurostocks.com/0/b558d4b39b214812/webshop/products/991070/xxlarge/test-product-nl-ot0khfry.jpg"
        }
      ]
    }
  ],
  "customerDetails": {
    "companyName": "",
    "vatNumber": "",
    "salutation": "Salutation_Mr",
    "firstName": "Dhrumin",
    "middleName": "",
    "lastName": "Chandarana",
    "email": "[email protected]",
    "telephone": "+3168484564",
    "licensePlate": "",
    "vinNumber": "",
    "billingAddress": {
      "street": "Jacob van Lennepkade",
      "houseNumber": 255,
      "houseNumberExtension": "hs",
      "postalCode": "1054zs",
      "country": "Nederland"
    }
  },
  "shippingAddress": {
    "toTheAttensionOf": "",
    "salutation": "Salutation_Mr",
    "firstName": "Dhrumin",
    "middleName": "",
    "lastName": "Chandarana",
    "street": "Jacob van Lennepkade",
    "houseNumber": 255,
    "houseNumberExtension": "hs",
    "postalCode": "1054zs",
    "city": "Amsterdam",
    "country": "Nederland"
  }
}

Update Processed By Integrator Flag

PATCH /api/v1/order/{orderId}/{processedByIntegrator}

Request Parameters

Name
Type
Description

orderId*

Integer

Id of the Order (required).

processedByIntegrator*

Boolean

Value of flag, it can be either “true” or “false” (required).

Headers

Name
Type
Description

UserName*

String

Username which EuroStocks provides

Password*

String

Password which EuroStocks provides

APIKey*

String

ApiKey which EuroStocks provides

Sample Success Request

PATCH
https://orders-api.eurostocks.com/api/v1/order/1488616/true

Update Order Status

PATCH /api/v1/order/status

Request JSON Parameters

Name
Type
Description

orderId*

Integer

Id of the Order

isTrash*

Boolean

Value of flag, it can be either “true” or “false” based on moving to Archive OR Trash

sendToCustomer*

Boolean

Value of flag, it can be either “true” or “false”

languageIsoCode*

String

Language ISO code Example: nl, en

remarks

String

Text for remarks which is sent in email for moving to Archive

sendInvoiceAsAttachment*

Boolean

Value of flag, it can be either “true” or “false”

Headers

Name
Type
Description

UserName*

String

Username which EuroStocks provides

Password*

String

Password which EuroStocks provides

APIKey*

String

APIKey which EuroStocks provides

Sample Success Request for Archive

PATCH
https://orders-api.eurostocks.com/api/v1/order/status
{
  "orderId": 2119142,
  "isTrash": false,
  "sendToCustomer": true,
  "languageIsoCode": "nl",
  "remarks": "Testing Order Status Email....................",
  "sendInvoiceAsAttachment": true
}

Sample Success Response for Archive

HTTP/1.1 200 OK
{
    "Status": 200,
    "Message": "Order status changed to Archive",
    "Result": 2119142
}

Sample Success Request for Trash

PATCH
https://orders-api.eurostocks.com/api/v1/order/status
{
  "orderId": 2119135,
  "isTrash": true,
  "sendToCustomer": false,
  "languageIsoCode": "nl",
  "remarks": "",
  "sendInvoiceAsAttachment": false
}

Sample Success Response for Trash

HTTP/1.1 200 OK
{
    "Status": 200,
    "Message": "Order status changed to Trash",
    "Result": 2119135
}

Update Order to Previous Status

PATCH /api/v1/order/previousStatus

Request JSON Parameters

Name
Type
Description

orderIds*

Array

Array of Order Id's

Headers

Name
Type
Description

UserName*

String

Username which EuroStocks provides

Password*

String

Password which EuroStocks provides

APIKey*

String

APIKey which EuroStocks provides

Sample Success Request

PATCH
https://orders-api.eurostocks.com/api/v1/order/previousStatus 
{
  "orderIds": [
    2119142,
    2119135
  ]
}

Sample Success Response

HTTP/1.1 200 OK
{
    "Status": 200,
    "Message": "Provided orders have been successfully reverted to their previous statuses",
    "Result": 0
}

Refund Order

POST /api/v1/order/refund

Request JSON Parameters

Name
Type
Description

orderId*

Integer

Id of the Order

amount*

Number

Amount to be refunded (should be less then total amount)

Headers

Name
Type
Description

UserName*

String

Username which EuroStocks provides

Password*

String

Password which EuroStocks provides

APIKey*

String

APIKey which EuroStocks provides

Sample Success Request

POST
https://orders-api.eurostocks.com/api/v1/order/refund
{
    "orderId": 2119142,
    "amount": 0.05
}

Sample Success Response

HTTP/1.1 200 OK
{
    "Status": 200,
    "Message": "",
    "Result": {
        "resource": {resource},
        "id": {id},
        "mode": {mode},
        "amount": {amount},
        "status": "{status}",
        "createdAt": {createdAt},
        "description": "{Response from Mollie}",
        "metadata": {metadata},
        "paymentId": {paymentId},
        "settlementAmount": {settlementAmount},
        "links": {links}
    }
}

Get Order Statuses

GET /api/v1/orderStatus

Request Parameters

Name
Type
Description

languageISOCode*

String

ISO Code of the language for which you want to fetch the data (required).

Headers

Name
Type
Description

UserName*

String

Username which EuroStocks provides

Password*

String

Password which EuroStocks provides

APIKey*

String

ApiKey which EuroStocks provides

Sample Success Request

GET
https://orders-api.eurostocks.com/api/v1/orderStatus/nl

Sample Success Response

HTTP/1.1 200 OK
[
  {
    "code": "OrderStatus_New",
    "displayText": "New",
    "languageISOCode": "nl"
  },
  {
    "code": "OrderStatus_Archive",
    "displayText": "Archive",
    "languageISOCode": "nl"
  },
  {
    "code": "OrderStatus_Trash",
    "displayText": "Trash.",
    "languageISOCode": "nl"
  }
]

Get Payment Statuses

GET /api/v1/paymentStatus

Request Parameters

Name
Type
Description

languageISOCode*

String

ISO Code of the language for which you want to fetch the data (required).

Headers

Name
Type
Description

UserName*

String

Username which EuroStocks provides

Password*

String

Password which EuroStocks provides

APIKe*

String

ApiKey which EuroStocks provides

Sample Success Request

GET
https://orders-api.eurostocks.com/api/v1/paymentStatus/nl

Sample Success Response

HTTP/1.1 200 OK
[
  {
    "code": "PaymentStatus_Refund",
    "displayText": "Refund",
    "languageISOCode": "nl"
  },
  {
    "code": "PaymentStatus_Open",
    "displayText": "Open",
    "languageISOCode": "nl"
  },
  {
    "code": "PaymentStatus_Cancelled",
    "displayText": "Geannuleerd",
    "languageISOCode": "nl"
  },
  {
    "code": "PaymentStatus_Pending",
    "displayText": "In afwachting",
    "languageISOCode": "nl"
  },
  {
    "code": "PaymentStatus_Expired",
    "displayText": "Verlopen",
    "languageISOCode": "nl"
  },
  {
    "code": "PaymentStatus_Paid",
    "displayText": "Betaald",
    "languageISOCode": "nl"
  },
  {
    "code": "PaymentStatus_Failed",
    "displayText": "Mislukt",
    "languageISOCode": "nl"
  }
]

Get Salutations

GET /api/Salutation

Request Parameters

Name
Type
Description

languageISOCode*

String

ISO Code of the language for which you want to fetch the data (required).

Headers

Name
Type
Description

UserName*

String

Username which EuroStocks provides

Password*

String

Password which EuroStocks provides

APIKey*

String

ApiKey which EuroStocks provides

Sample Success Request

GET
https://orders-api.eurostocks.com/api/Salutation/nl

Sample Success Response

HTTP/1.1 200 OK
[
  {
    "code": "Salutation_Mr",
    "displayText": "Dhr.",
    "languageISOCode": "nl"
  },
  {
    "code": "Salutation_Mrs",
    "displayText": "Mvr.",
    "languageISOCode": "nl"
  }
]

Get Sort Order List

GET /api/v1/sortOrder

Request Parameters

Name
Type
Description

languageISOCode*

String

ISO Code of the language for which you want to fetch the data (required).

Headers

Name
Type
Description

UserName*

String

Username which EuroStocks provides

Password*

String

Password which EuroStocks provides

APIKey*

String

ApiKey which EuroStocks provides

Sample Success Request

GET
https://orders-api.eurostocks.com/api/v1/sortOrder/nl

Sample Success Response

HTTP/1.1 200 OK
[
  {
    "code": "SortOrder_Asc",
    "displayText": "Oplopend",
    "languageISOCode": "nl"
  },
  {
    "code": "SortOrder_Desc",
    "displayText": "Aflopend",
    "languageISOCode": "nl"
  }
]
PreviousLicense Plate API

Last updated