# Orders API

## 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/](https://orders-api.eurostocks.com/)

## Working with Orders API

## Get Orders list

<mark style="color:blue;">`GET`</mark> `/api/v1/order/list/{orderStatus}/{paymentStatus}/{sortOrder}/{pageNumber}/{pageSize}/{processedByIntegrator}/{fromDate}/{toDate}/{search}`&#x20;

### Request Parameters

| Name                                            | Type    | Description                                                                      |
| ----------------------------------------------- | ------- | -------------------------------------------------------------------------------- |
| orderStatus<mark style="color:red;">\*</mark>   | String  | Status of the Order                                                              |
| paymentStatus<mark style="color:red;">\*</mark> | String  | Status of the Payment                                                            |
| sortOrder<mark style="color:red;">\*</mark>     | String  | Sorting Order of the list                                                        |
| pageNumber<mark style="color:red;">\*</mark>    | Integer | Page Number of the list                                                          |
| pageSize<mark style="color:red;">\*</mark>      | 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<mark style="color:red;">\*</mark> | String | Username which EuroStocks provides |
| Password<mark style="color:red;">\*</mark> | String | Password which EuroStocks provides |
| APIKey<mark style="color:red;">\*</mark>   | String | APIKey which EuroStocks provides   |

### Sample Success Request

{% code title="GET" overflow="wrap" %}

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

{% endcode %}

### Sample Success Response

**Note:** All the DateTime in below response is in 24-hour UTC format&#x20;

{% code title="HTTP/1.1 200 OK" overflow="wrap" fullWidth="false" expandable="true" %}

```json
{
    "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": "AdVermeulen2007@gmail.com",
            "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": "leondebruijn@ziggo.nl",
            "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": "karamrambo2001@gmail.com",
            "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": "Topglasleeuwarden@gmail.com",
            "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": "tomvdmeulenreek@ziggo.nl",
            "orderSource": "www.autoonderdelenveghel.nl"
        }
    ],
    "totalPages": 8872,
    "totalRows": 44356,
    "currentPageNumber": 1
}
```

{% endcode %}

## Get Order Details

<mark style="color:blue;">`GET`</mark> `/api/v1/order/details/{orderId}/{languageISOCode}`

### Request Parameters

| Name                                              | Type    | Description                                                               |
| ------------------------------------------------- | ------- | ------------------------------------------------------------------------- |
| orderId<mark style="color:red;">\*</mark>         | Integer | Id of the Order (required).                                               |
| languageISOCode<mark style="color:red;">\*</mark> | String  | ISO Code of the language for which you want to fetch the data (required). |

### Headers

| Name                                       | Type   | Description                        |
| ------------------------------------------ | ------ | ---------------------------------- |
| UserName<mark style="color:red;">\*</mark> | String | Username which EuroStocks provides |
| Password<mark style="color:red;">\*</mark> | String | Password which EuroStocks provides |
| APIKey<mark style="color:red;">\*</mark>   | String | ApiKey which EuroStocks provides   |

### Sample Success Request

{% code title="GET" overflow="wrap" %}

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

{% endcode %}

### Sample Success Response

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

{% code title="HTTP/1.1 200 OK" overflow="wrap" expandable="true" %}

```json
{
  "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": "dhrumin@eurostocks.com",
    "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"
  }
}

```

{% endcode %}

## Update Processed By Integrator Flag

<mark style="color:purple;">`PATCH`</mark> `/api/v1/order/{orderId}/{processedByIntegrator}`

### Request Parameters

| Name                                                    | Type    | Description                                                   |
| ------------------------------------------------------- | ------- | ------------------------------------------------------------- |
| orderId<mark style="color:red;">\*</mark>               | Integer | Id of the Order (required).                                   |
| processedByIntegrator<mark style="color:red;">\*</mark> | Boolean | Value of flag, it can be either “true” or “false” (required). |

### Headers

| Name                                       | Type   | Description                        |
| ------------------------------------------ | ------ | ---------------------------------- |
| UserName<mark style="color:red;">\*</mark> | String | Username which EuroStocks provides |
| Password<mark style="color:red;">\*</mark> | String | Password which EuroStocks provides |
| APIKey<mark style="color:red;">\*</mark>   | String | ApiKey which EuroStocks provides   |

### Sample Success Request

{% code title="PATCH" overflow="wrap" expandable="true" %}

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

{% endcode %}

## Update Order Status

<mark style="color:purple;">`PATCH`</mark> `/api/v1/order/status`

### Request JSON Parameters

| Name                                                      | Type    | Description                                                                           |
| --------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------- |
| orderId<mark style="color:red;">\*</mark>                 | Integer | Id of the Order                                                                       |
| isTrash<mark style="color:red;">\*</mark>                 | Boolean | Value of flag, it can be either “true” or “false” based on moving to Archive OR Trash |
| sendToCustomer<mark style="color:red;">\*</mark>          | Boolean | Value of flag, it can be either “true” or “false”                                     |
| languageIsoCode<mark style="color:red;">\*</mark>         | String  | <p>Language ISO code<br>Example: nl, en </p>                                          |
| remarks                                                   | String  | Text for remarks which is sent in email for moving to Archive                         |
| sendInvoiceAsAttachment<mark style="color:red;">\*</mark> | Boolean | Value of flag, it can be either “true” or “false”                                     |

### Headers

| Name                                       | Type   | Description                        |
| ------------------------------------------ | ------ | ---------------------------------- |
| UserName<mark style="color:red;">\*</mark> | String | Username which EuroStocks provides |
| Password<mark style="color:red;">\*</mark> | String | Password which EuroStocks provides |
| APIKey<mark style="color:red;">\*</mark>   | String | APIKey which EuroStocks provides   |

### Sample Success Request for Archive

{% code title="PATCH" overflow="wrap" expandable="true" %}

```
https://orders-api.eurostocks.com/api/v1/order/status
```

{% endcode %}

{% code overflow="wrap" expandable="true" %}

```json
{
  "orderId": 2119142,
  "isTrash": false,
  "sendToCustomer": true,
  "languageIsoCode": "nl",
  "remarks": "Testing Order Status Email....................",
  "sendInvoiceAsAttachment": true
}
```

{% endcode %}

### Sample Success Response for Archive

{% code title="HTTP/1.1 200 OK" overflow="wrap" expandable="true" %}

```json
{
    "Status": 200,
    "Message": "Order status changed to Archive",
    "Result": 2119142
}
```

{% endcode %}

### Sample Success Request for Trash

{% code title="PATCH" overflow="wrap" expandable="true" %}

```
https://orders-api.eurostocks.com/api/v1/order/status
```

{% endcode %}

{% code overflow="wrap" expandable="true" %}

```json
{
  "orderId": 2119135,
  "isTrash": true,
  "sendToCustomer": false,
  "languageIsoCode": "nl",
  "remarks": "",
  "sendInvoiceAsAttachment": false
}
```

{% endcode %}

### Sample Success Response for Trash

{% code title="HTTP/1.1 200 OK" overflow="wrap" expandable="true" %}

```json
{
    "Status": 200,
    "Message": "Order status changed to Trash",
    "Result": 2119135
}
```

{% endcode %}

## Update Order to Previous Status

<mark style="color:purple;">`PATCH`</mark> `/api/v1/order/previousStatus`

### Request JSON Parameters

| Name                                       | Type  | Description         |
| ------------------------------------------ | ----- | ------------------- |
| orderIds<mark style="color:red;">\*</mark> | Array | Array of Order Id's |

### Headers

| Name                                       | Type   | Description                        |
| ------------------------------------------ | ------ | ---------------------------------- |
| UserName<mark style="color:red;">\*</mark> | String | Username which EuroStocks provides |
| Password<mark style="color:red;">\*</mark> | String | Password which EuroStocks provides |
| APIKey<mark style="color:red;">\*</mark>   | String | APIKey which EuroStocks provides   |

### Sample Success Request

{% code title="PATCH" overflow="wrap" expandable="true" %}

```
https://orders-api.eurostocks.com/api/v1/order/previousStatus 
```

{% endcode %}

{% code overflow="wrap" expandable="true" %}

```json
{
  "orderIds": [
    2119142,
    2119135
  ]
}
```

{% endcode %}

### Sample Success Response

{% code title="HTTP/1.1 200 OK" overflow="wrap" expandable="true" %}

```json
{
    "Status": 200,
    "Message": "Provided orders have been successfully reverted to their previous statuses",
    "Result": 0
}
```

{% endcode %}

## Refund Order

<mark style="color:purple;">`POST`</mark> `/api/v1/order/refund`

### Request JSON Parameters

| Name                                      | Type    | Description                                              |
| ----------------------------------------- | ------- | -------------------------------------------------------- |
| orderId<mark style="color:red;">\*</mark> | Integer | Id of the Order                                          |
| amount<mark style="color:red;">\*</mark>  | Number  | Amount to be refunded (should be less then total amount) |

### Headers

| Name                                       | Type   | Description                        |
| ------------------------------------------ | ------ | ---------------------------------- |
| UserName<mark style="color:red;">\*</mark> | String | Username which EuroStocks provides |
| Password<mark style="color:red;">\*</mark> | String | Password which EuroStocks provides |
| APIKey<mark style="color:red;">\*</mark>   | String | APIKey which EuroStocks provides   |

### Sample Success Request

{% code title="POST" overflow="wrap" expandable="true" %}

```
https://orders-api.eurostocks.com/api/v1/order/refund
```

{% endcode %}

{% code overflow="wrap" expandable="true" %}

```json
{
    "orderId": 2119142,
    "amount": 0.05
}
```

{% endcode %}

### Sample Success Response

{% code title="HTTP/1.1 200 OK" overflow="wrap" expandable="true" %}

```json
{
    "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}
    }
}
```

{% endcode %}

## Get Order Statuses

<mark style="color:blue;">`GET`</mark> `/api/v1/orderStatus`

### Request Parameters

| Name                                              | Type   | Description                                                               |
| ------------------------------------------------- | ------ | ------------------------------------------------------------------------- |
| languageISOCode<mark style="color:red;">\*</mark> | String | ISO Code of the language for which you want to fetch the data (required). |

### Headers

| Name                                       | Type   | Description                        |
| ------------------------------------------ | ------ | ---------------------------------- |
| UserName<mark style="color:red;">\*</mark> | String | Username which EuroStocks provides |
| Password<mark style="color:red;">\*</mark> | String | Password which EuroStocks provides |
| APIKey<mark style="color:red;">\*</mark>   | String | ApiKey which EuroStocks provides   |

### Sample Success Request

{% code title="GET" overflow="wrap" expandable="true" %}

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

{% endcode %}

### Sample Success Response

{% code title="HTTP/1.1 200 OK" overflow="wrap" expandable="true" %}

```json
[
  {
    "code": "OrderStatus_New",
    "displayText": "New",
    "languageISOCode": "nl"
  },
  {
    "code": "OrderStatus_Archive",
    "displayText": "Archive",
    "languageISOCode": "nl"
  },
  {
    "code": "OrderStatus_Trash",
    "displayText": "Trash.",
    "languageISOCode": "nl"
  }
]
```

{% endcode %}

## Get Payment Statuses

<mark style="color:blue;">`GET`</mark> `/api/v1/paymentStatus`

### Request Parameters

| Name                                              | Type   | Description                                                               |
| ------------------------------------------------- | ------ | ------------------------------------------------------------------------- |
| languageISOCode<mark style="color:red;">\*</mark> | String | ISO Code of the language for which you want to fetch the data (required). |

### Headers

| Name                                       | Type   | Description                        |
| ------------------------------------------ | ------ | ---------------------------------- |
| UserName<mark style="color:red;">\*</mark> | String | Username which EuroStocks provides |
| Password<mark style="color:red;">\*</mark> | String | Password which EuroStocks provides |
| APIKe<mark style="color:red;">\*</mark>    | String | ApiKey which EuroStocks provides   |

### Sample Success Request

{% code title="GET" overflow="wrap" expandable="true" %}

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

{% endcode %}

### Sample Success Response

{% code title="HTTP/1.1 200 OK" overflow="wrap" expandable="true" %}

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

{% endcode %}

## Get Salutations

<mark style="color:blue;">`GET`</mark> `/api/Salutation`

### Request Parameters

| Name                                              | Type   | Description                                                               |
| ------------------------------------------------- | ------ | ------------------------------------------------------------------------- |
| languageISOCode<mark style="color:red;">\*</mark> | String | ISO Code of the language for which you want to fetch the data (required). |

### Headers

| Name                                       | Type   | Description                        |
| ------------------------------------------ | ------ | ---------------------------------- |
| UserName<mark style="color:red;">\*</mark> | String | Username which EuroStocks provides |
| Password<mark style="color:red;">\*</mark> | String | Password which EuroStocks provides |
| APIKey<mark style="color:red;">\*</mark>   | String | ApiKey which EuroStocks provides   |

### Sample Success Request

{% code title="GET" overflow="wrap" expandable="true" %}

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

{% endcode %}

### Sample Success Response

{% code title="HTTP/1.1 200 OK" overflow="wrap" expandable="true" %}

```json
[
  {
    "code": "Salutation_Mr",
    "displayText": "Dhr.",
    "languageISOCode": "nl"
  },
  {
    "code": "Salutation_Mrs",
    "displayText": "Mvr.",
    "languageISOCode": "nl"
  }
]
```

{% endcode %}

## Get Sort Order List

<mark style="color:blue;">`GET`</mark> `/api/v1/sortOrder`

### Request Parameters

| Name                                              | Type   | Description                                                               |
| ------------------------------------------------- | ------ | ------------------------------------------------------------------------- |
| languageISOCode<mark style="color:red;">\*</mark> | String | ISO Code of the language for which you want to fetch the data (required). |

### Headers

| Name                                       | Type   | Description                        |
| ------------------------------------------ | ------ | ---------------------------------- |
| UserName<mark style="color:red;">\*</mark> | String | Username which EuroStocks provides |
| Password<mark style="color:red;">\*</mark> | String | Password which EuroStocks provides |
| APIKey<mark style="color:red;">\*</mark>   | String | ApiKey which EuroStocks provides   |

### Sample Success Request

{% code title="GET" overflow="wrap" expandable="true" %}

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

{% endcode %}

### Sample Success Response

{% code title="HTTP/1.1 200 OK" overflow="wrap" expandable="true" %}

```json
[
  {
    "code": "SortOrder_Asc",
    "displayText": "Oplopend",
    "languageISOCode": "nl"
  },
  {
    "code": "SortOrder_Desc",
    "displayText": "Aflopend",
    "languageISOCode": "nl"
  }
]
```

{% endcode %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.eurostocks.com/orders-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.