Orders API

Orders API Documentation

Introduction

Overview

The EuroStocks Orders-API is an interface to provide information for classified orders.

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

The API is available at this base URL:

https://orders-api.eurostocks.comorders-api.eurostocks.com

Main Features

  • Orders List

  • Order Details

  • Update ProcessedByIntegrator flag

Prerequisites

Orders API access can be granted to suppliers who wants to get orders informations, 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 url https://test-orders-api.eurostocks.com.

Working with Orders API

Get Orders list

GET /api/v1/order/list

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

Query Parameters

Name
Type
Description

orderStatus*

String

Status of the Order (required).

paymentStatus*

String

Status of the Payment (required).

sortOrder*

String

Sorting Order of the list (required).

pageNumber*

Integer

Page Number of the list (required).

pageSize*

Integer

Page Size of the list (required).

processedByIntegrator

Boolean

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

fromDate

String

From Date for the list (optional).

toDate

String

To Date for the list (optional).

search

String

Search text in the list (optional).

Headers

Name
Type
Description

UserName*

String

Username which EuroStocks provides

Password*

String

Password which EuroStocks provides

APIKey*

String

ApiKey which EuroStocks provides

{

"orders": [

{

"orderId": 1488616,

"orderStatus": "OrderStatus_New",

"orderDateTime": "2023-07-21T11:44:04.893Z",

"totalItemsOrdered": 1,

"orderAmount": 1012.49,

"orderCurrency": "EUR",

"paymentStatus": "PaymentStatus_Paid",

"paymentInitiated": true,

"paymentExpired": false,

"processedByIntegrator": false,

"customerType": "CustomerType_Guest",

"salutation": "Salutation_Mr",

"customerName": "Dhrumin Chandarana",

"customerEmail": "[email protected]",

"orderSource": "directautos.eu"

},

{

"orderId": 1488570,

"orderStatus": "OrderStatus_New",

"orderDateTime": "2023-07-21T08:35:27.557Z",

"totalItemsOrdered": 1,

"orderAmount": 11.52,

"orderCurrency": "EUR",

"paymentStatus": "PaymentStatus_Paid",

"paymentInitiated": true,

"paymentExpired": false,

"processedByIntegrator": false,

"customerType": "CustomerType_Registered",

"salutation": "Salutation_Mr",

"customerName": "Montu P Patel",

"customerEmail": "[email protected]",

"orderSource": "www.mercedesreparaties.nl"

},

{

"orderId": 1488547,

"orderStatus": "OrderStatus_New",

"orderDateTime": "2023-07-20T02:08:38.233Z",

"totalItemsOrdered": 1,

"orderAmount": 1012.49,

"orderCurrency": "EUR",

"paymentStatus": "PaymentStatus_Paid",

"paymentInitiated": true,

"paymentExpired": false,

"processedByIntegrator": false,

"customerType": "CustomerType_Guest",

"salutation": "Salutation_Mr",

"customerName": "D C",

"customerEmail": "[email protected]",

"orderSource": "directautos.eu"

},

{

"orderId": 1488538,

"orderStatus": "OrderStatus_New",

"orderDateTime": "2023-07-20T02:05:30.333Z",

"totalItemsOrdered": 1,

"orderAmount": 1012.49,

"orderCurrency": "EUR",

"paymentStatus": "PaymentStatus_Paid",

"paymentInitiated": true,

"paymentExpired": false,

"processedByIntegrator": false,

"customerType": "CustomerType_Guest",

"salutation": "Salutation_Mr",

"customerName": "D C",

"customerEmail": "[email protected]",

"orderSource": "directautos.eu"

},

{

"orderId": 1488529,

"orderStatus": "OrderStatus_New",

"orderDateTime": "2023-07-20T02:03:37.297Z",

"totalItemsOrdered": 1,

"orderAmount": 1012.49,

"orderCurrency": "EUR",

"paymentStatus": "PaymentStatus_Paid",

"paymentInitiated": true,

"paymentExpired": false,

"processedByIntegrator": false,

"customerType": "CustomerType_Guest",

"salutation": "Salutation_Mr",

"customerName": "D C",

"customerEmail": "[email protected]",

"orderSource": "directautos.eu"

},

{

"orderId": 1488520,

"orderStatus": "OrderStatus_New",

"orderDateTime": "2023-07-20T02:01:36.140Z",

"totalItemsOrdered": 1,

"orderAmount": 1012.49,

"orderCurrency": "EUR",

"paymentStatus": "PaymentStatus_Paid",

"paymentInitiated": true,

"paymentExpired": false,

"processedByIntegrator": false,

"customerType": "CustomerType_Guest",

"salutation": "Salutation_Mr",

"customerName": "D C",

"customerEmail": "[email protected]",

"orderSource": "directautos.eu"

},

{

"orderId": 1488511,

"orderStatus": "OrderStatus_New",

"orderDateTime": "2023-07-20T01:48:39.310Z",

"totalItemsOrdered": 1,

"orderAmount": 1012.49,

"orderCurrency": "EUR",

"paymentStatus": "PaymentStatus_Paid",

"paymentInitiated": true,

"paymentExpired": false,

"processedByIntegrator": false,

"customerType": "CustomerType_Guest",

"salutation": "Salutation_Mr",

"customerName": "D C",

"customerEmail": "[email protected]",

"orderSource": "directautos.eu"

},

{

"orderId": 1488502,

"orderStatus": "OrderStatus_New",

"orderDateTime": "2023-07-20T12:37:48.957Z",

"totalItemsOrdered": 1,

"orderAmount": 1012.49,

"orderCurrency": "EUR",

"paymentStatus": "PaymentStatus_Paid",

"paymentInitiated": true,

"paymentExpired": false,

"processedByIntegrator": false,

"customerType": "CustomerType_Guest",

"salutation": "Salutation_Mr",

"customerName": "D C",

"customerEmail": "[email protected]",

"orderSource": "directautos.eu"

},

{

"orderId": 1488493,

"orderStatus": "OrderStatus_New",

"orderDateTime": "2023-07-20T12:25:21.590Z",

"totalItemsOrdered": 1,

"orderAmount": 1012.49,

"orderCurrency": "EUR",

"paymentStatus": "PaymentStatus_Paid",

"paymentInitiated": true,

"paymentExpired": false,

"processedByIntegrator": false,

"customerType": "CustomerType_Guest",

"salutation": "Salutation_Mr",

"customerName": "Dhrumin C",

"customerEmail": "[email protected]",

"orderSource": "directautos.eu"

},

{

"orderId": 1488484,

"orderStatus": "OrderStatus_New",

"orderDateTime": "2023-07-20T12:07:32.223Z",

"totalItemsOrdered": 1,

"orderAmount": 1230,

"orderCurrency": "EUR",

"paymentStatus": "PaymentStatus_Paid",

"paymentInitiated": true,

"paymentExpired": false,

"processedByIntegrator": false,

"customerType": "CustomerType_Guest",

"salutation": "Salutation_Mr",

"customerName": "Dhrumin Chandarana",

"customerEmail": "[email protected]",

"orderSource": "www.nlcarparts.nl"

}

],

"totalPages": 1990,

"totalRows": 19894,

"currentPageNumber": 1

}

Sample Success Request

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

Sample Success Response

HTTP/1.1 200 OK

{
  "orders": [
    {
      "orderId": 1488616,
      "orderStatus": "OrderStatus_New",
      "orderDateTime": "2023-07-21T11:44:04.893Z",
      "totalItemsOrdered": 1,
      "orderAmount": 1012.49,
      "orderCurrency": "EUR",
      "paymentStatus": "PaymentStatus_Paid",
      "paymentInitiated": true,
      "paymentExpired": false,
      "processedByIntegrator": false,
      "customerType": "CustomerType_Guest",
      "salutation": "Salutation_Mr",
      "customerName": "Dhrumin Chandarana",
      "customerEmail": "[email protected]",
      "orderSource": "directautos.eu"
    },
    {
      "orderId": 1488570,
      "orderStatus": "OrderStatus_New",
      "orderDateTime": "2023-07-21T08:35:27.557Z",
      "totalItemsOrdered": 1,
      "orderAmount": 11.52,
      "orderCurrency": "EUR",
      "paymentStatus": "PaymentStatus_Paid",
      "paymentInitiated": true,
      "paymentExpired": false,
      "processedByIntegrator": false,
      "customerType": "CustomerType_Registered",
      "salutation": "Salutation_Mr",
      "customerName": "Montu P Patel",
      "customerEmail": "[email protected]",
      "orderSource": "www.mercedesreparaties.nl"
    },
    {
      "orderId": 1488547,
      "orderStatus": "OrderStatus_New",
      "orderDateTime": "2023-07-20T02:08:38.233Z",
      "totalItemsOrdered": 1,
      "orderAmount": 1012.49,
      "orderCurrency": "EUR",
      "paymentStatus": "PaymentStatus_Paid",
      "paymentInitiated": true,
      "paymentExpired": false,
      "processedByIntegrator": false,
      "customerType": "CustomerType_Guest",
      "salutation": "Salutation_Mr",
      "customerName": "D C",
      "customerEmail": "[email protected]",
      "orderSource": "directautos.eu"
    },
    {
      "orderId": 1488538,
      "orderStatus": "OrderStatus_New",
      "orderDateTime": "2023-07-20T02:05:30.333Z",
      "totalItemsOrdered": 1,
      "orderAmount": 1012.49,
      "orderCurrency": "EUR",
      "paymentStatus": "PaymentStatus_Paid",
      "paymentInitiated": true,
      "paymentExpired": false,
      "processedByIntegrator": false,
      "customerType": "CustomerType_Guest",
      "salutation": "Salutation_Mr",
      "customerName": "D C",
      "customerEmail": "[email protected]",
      "orderSource": "directautos.eu"
    },
    {
      "orderId": 1488529,
      "orderStatus": "OrderStatus_New",
      "orderDateTime": "2023-07-20T02:03:37.297Z",
      "totalItemsOrdered": 1,
      "orderAmount": 1012.49,
      "orderCurrency": "EUR",
      "paymentStatus": "PaymentStatus_Paid",
      "paymentInitiated": true,
      "paymentExpired": false,
      "processedByIntegrator": false,
      "customerType": "CustomerType_Guest",
      "salutation": "Salutation_Mr",
      "customerName": "D C",
      "customerEmail": "[email protected]",
      "orderSource": "directautos.eu"
    },
    {
      "orderId": 1488520,
      "orderStatus": "OrderStatus_New",
      "orderDateTime": "2023-07-20T02:01:36.140Z",
      "totalItemsOrdered": 1,
      "orderAmount": 1012.49,
      "orderCurrency": "EUR",
      "paymentStatus": "PaymentStatus_Paid",
      "paymentInitiated": true,
      "paymentExpired": false,
      "processedByIntegrator": false,
      "customerType": "CustomerType_Guest",
      "salutation": "Salutation_Mr",
      "customerName": "D C",
      "customerEmail": "[email protected]",
      "orderSource": "directautos.eu"
    },
    {
      "orderId": 1488511,
      "orderStatus": "OrderStatus_New",
      "orderDateTime": "2023-07-20T01:48:39.310Z",
      "totalItemsOrdered": 1,
      "orderAmount": 1012.49,
      "orderCurrency": "EUR",
      "paymentStatus": "PaymentStatus_Paid",
      "paymentInitiated": true,
      "paymentExpired": false,
      "processedByIntegrator": false,
      "customerType": "CustomerType_Guest",
      "salutation": "Salutation_Mr",
      "customerName": "D C",
      "customerEmail": "[email protected]",
      "orderSource": "directautos.eu"
    },
    {
      "orderId": 1488502,
      "orderStatus": "OrderStatus_New",
      "orderDateTime": "2023-07-20T12:37:48.957Z",
      "totalItemsOrdered": 1,
      "orderAmount": 1012.49,
      "orderCurrency": "EUR",
      "paymentStatus": "PaymentStatus_Paid",
      "paymentInitiated": true,
      "paymentExpired": false,
      "processedByIntegrator": false,
      "customerType": "CustomerType_Guest",
      "salutation": "Salutation_Mr",
      "customerName": "D C",
      "customerEmail": "[email protected]",
      "orderSource": "directautos.eu"
    },
    {
      "orderId": 1488493,
      "orderStatus": "OrderStatus_New",
      "orderDateTime": "2023-07-20T12:25:21.590Z",
      "totalItemsOrdered": 1,
      "orderAmount": 1012.49,
      "orderCurrency": "EUR",
      "paymentStatus": "PaymentStatus_Paid",
      "paymentInitiated": true,
      "paymentExpired": false,
      "processedByIntegrator": false,
      "customerType": "CustomerType_Guest",
      "salutation": "Salutation_Mr",
      "customerName": "Dhrumin C",
      "customerEmail": "[email protected]",
      "orderSource": "directautos.eu"
    },
    {
      "orderId": 1488484,
      "orderStatus": "OrderStatus_New",
      "orderDateTime": "2023-07-20T12:07:32.223Z",
      "totalItemsOrdered": 1,
      "orderAmount": 1230,
      "orderCurrency": "EUR",
      "paymentStatus": "PaymentStatus_Paid",
      "paymentInitiated": true,
      "paymentExpired": false,
      "processedByIntegrator": false,
      "customerType": "CustomerType_Guest",
      "salutation": "Salutation_Mr",
      "customerName": "Dhrumin Chandarana",
      "customerEmail": "[email protected]",
      "orderSource": "www.nlcarparts.nl"
    }
  ],
  "totalPages": 1990,
  "totalRows": 19894,
  "currentPageNumber": 1
}

Get Order Details

GET /api/v1/order/details

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

Query 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

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

Sample Success Response

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

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

Query 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

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

Get Order Statuses

GET /api/v1/orderStatus

Query 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

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

Query 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

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

Query 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

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

Query 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

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