# GetOrderHistoryDetail

**Description**

With this method we want to receive the order details of a given order number.

## SOAP API:

**Action**

http://shoxl.com/ShoxlService/GetOrderHistoryDetail

{% hint style="info" %}
Please note: this is not a working url, but a combination of namespace and method. Do not expect the url to return a result.
{% endhint %}

**Style**

Document

## Input (Literal)

The input of this method is the document element tns:GetOrderHistoryDetail having the structure defined by the following table.

<table data-header-hidden><thead><tr><th width="159">Element</th><th>Type</th><th width="154">Occurs</th><th>Description</th></tr></thead><tbody><tr><td>Element</td><td>Type</td><td>Occurs</td><td>Description</td></tr><tr><td>Sequence</td><td></td><td>1..1</td><td></td></tr><tr><td>request</td><td>tns:GetOrderHistoryDetailRequest</td><td>0..1</td><td></td></tr></tbody></table>

### _Complex Type: tns:GetOrderHistoryDetailRequest_

**Description**

The GetOrderHistoryDetailRequest contains all the information needed to get the

order details of a single order.

<table data-header-hidden><thead><tr><th width="169">Component</th><th width="194">Type</th><th width="152">Occurs</th><th>Description</th></tr></thead><tbody><tr><td>Component</td><td>Type</td><td>Occurs</td><td>Description</td></tr><tr><td>Sequence</td><td></td><td>1..1</td><td></td></tr><tr><td>OrderNumber</td><td>s:string</td><td>1..1</td><td>This the Shoxl Shop unique order number</td></tr></tbody></table>

## Output (Literal)

The output of this method is the document element tns:GetOrderHistoryDetailResponse having the structure defined by the following table.

<table data-header-hidden><thead><tr><th width="190">Element</th><th>Type</th><th width="150">Occurs</th><th>Description</th></tr></thead><tbody><tr><td>Element</td><td>Type</td><td>Occurs</td><td>Description</td></tr><tr><td>Sequence</td><td></td><td>1..1</td><td></td></tr><tr><td>GetOrderHistoryDetailResult</td><td>tns:GetOrderHistoryDetailResult</td><td>0..1</td><td></td></tr></tbody></table>

### _Complex Type: tns:GetOrderHistoryDetailResult_

**Description**

The GetOrderHistoryDetailResult contains the order details of the given order

number.

<table data-header-hidden><thead><tr><th width="190">Component</th><th width="155">Type</th><th width="150">Occurs</th><th>Description</th></tr></thead><tbody><tr><td>Component</td><td>Type</td><td>Occurs</td><td>Description</td></tr><tr><td>Sequence</td><td></td><td>1..1</td><td></td></tr><tr><td>ErrorCode</td><td>s:string</td><td>0..1</td><td>An error code returned by the ERP system</td></tr><tr><td>ErrorDescription</td><td>s:string</td><td>0..1</td><td>The error description related to the error code returned by the ERP system</td></tr><tr><td>Order</td><td>tns:Order</td><td>1..1</td><td>The Order, the ComplexType Order contains all the order details. For the complete description check the Order section in the documentation.</td></tr><tr><td>CustomerNumber</td><td>s:string</td><td>1..1</td><td>A unique customer number</td></tr><tr><td>Request</td><td>tns:GetOrderHistoryDetailRequest</td><td>1..1</td><td>The sent request by Shoxl Shop.</td></tr></tbody></table>



## REST API:

**URL:** /Shoxl/v1/GetOrderHistoryDetail\
**Method:** POST

**Request body:**

### &#x20;GetOrderHistoryDetailRequest{

| parameter   | type                      |
| ----------- | ------------------------- |
| orderNumber | <p>string<br>required</p> |

}

#### Example:

```
{
  "orderNumber": "string"
}
```



**Response body:**

### &#x20;GetOrderHistoryDetailResult{

| parameter        | type                            |
| ---------------- | ------------------------------- |
| customerNumber   | <p>string<br>nullable: true</p> |
| errorCode        | <p>string<br>nullable: true</p> |
| errorDescription | <p>string<br>nullable: true</p> |
| order            | Order                           |
| request          | GetOrderHistoryDetailRequest    |

}

#### Example:

```
{
  "customerNumber": "string",
  "errorCode": "string",
  "errorDescription": "string",
  "order": {
    "billingAddressLine1": "string",
    "billingStreet": "string",
    "billingHouseNumber": "string",
    "billingHouseNumberAddition": "string",
    "billingAddressLine2": "string",
    "billingStreetAddressType": 0,
    "billingCity": "string",
    "billingCountry": "string",
    "billingName1": "string",
    "billingName2": "string",
    "billingPostalCode": "string",
    "externalOrderNumber": "string",
    "orderDate": "2021-07-21",
    "orderLines": [
      {
        "baseUnit": "string",
        "carrier": "string",
        "discountAmountExclVat": 0,
        "discountDescription": "string",
        "discountPercentage": 0,
        "grossPriceExclVat": 0,
        "isExternal": true,
        "nettoPriceExclVat": 0,
        "nettoPriceInclVat": 0,
        "orderLineStatus": 0,
        "priceUnit": 0,
        "productDescription": "string",
        "productNumber": "string",
        "quantity": 0,
        "remainingQuantity": 0,
        "subTotalPriceExclVat": 0,
        "subTotalPriceInclVat": 0,
        "trackAndTraceReference": "string",
        "vatCode": 0
      }
    ],
    "orderState": 0,
    "orderedBy": "string",
    "paymentMethodCode": 0,
    "paymentReference": "string",
    "reference": "string",
    "shipmentMethodCode": 0,
    "shippingAddressLine1": "string",
    "shippingStreet": "string",
    "shippingHouseNumber": "string",
    "shippingHouseNumberAddition": "string",
    "shippingAddressLine2": "string",
    "shippingStreetAddressType": 0,
    "shippingCity": "string",
    "shippingCountry": "string",
    "shippingName1": "string",
    "shippingName2": "string",
    "shippingPostalCode": "string",
    "shippingTransportInstruction": "string",
    "totalPriceExclVat": 0,
    "totalPriceInclVat": 0,
    "totalVat": 0
  },
  "request": {
    "orderNumber": "string"
  }
}
```
