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

Please note: this is not a working url, but a combination of namespace and method. Do not expect the url to return a result.

Style

Document

Input (Literal)

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

Element	Type	Occurs	Description
Sequence		1..1
request	tns:GetOrderHistoryDetailRequest	0..1

Complex Type: tns:GetOrderHistoryDetailRequest

Description

The GetOrderHistoryDetailRequest contains all the information needed to get the

order details of a single order.

Component	Type	Occurs	Description
Sequence		1..1
OrderNumber	s:string	1..1	This the Shoxl Shop unique order number

Output (Literal)

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

Element	Type	Occurs	Description
Sequence		1..1
GetOrderHistoryDetailResult	tns:GetOrderHistoryDetailResult	0..1

Complex Type: tns:GetOrderHistoryDetailResult

Description

The GetOrderHistoryDetailResult contains the order details of the given order

number.

Component	Type	Occurs	Description
Sequence		1..1
ErrorCode	s:string	0..1	An error code returned by the ERP system
ErrorDescription	s:string	0..1	The error description related to the error code returned by the ERP system
Order	tns:Order	1..1	The Order, the ComplexType Order contains all the order details. For the complete description check the Order section in the documentation.
CustomerNumber	s:string	1..1	A unique customer number
Request	tns:GetOrderHistoryDetailRequest	1..1	The sent request by Shoxl Shop.

REST API:

URL: /Shoxl/v1/GetOrderHistoryDetail Method: POST

Changes in ShoxlRestApiSwagger_v8

• The vatCode field on OrderLine is replaced by a new taxPercentage field

Changes in ShoxlRestApiSwagger_v16

• A new field "context" is introduced in the request body. When configured this object contains key value pairs (e.g. divisionCode).

Changes in ShoxlRestApiSwagger_v17

• A new optional field "deliveryDate" was introduced for "orderLines".

Changes in ShoxlRestApiSwagger_v18

• A new field "type" was introduced for "orderLines".

  None = 0,
  Product = 1,
  Shipping = 2,
  Payment = 3,
  Other = 4,
  Discount = 5,
  DisposalFee = 6

Request body:

GetOrderHistoryDetailRequest{

parameter	type
orderNumber	string required
context	object

}

Example:

{
  "orderNumber": "string",
  "context": {
    "divisionCode": "string"
  }
}

Response body:

GetOrderHistoryDetailResult{

parameter	type
customerNumber	string nullable: true
errorCode	string nullable: true
errorDescription	string nullable: true
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",
    "billingExternalId" : "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,
        "taxPercentage": 0,
        "trackAndTraceReference": "string",
        "deliveryDate": "2021-07-21",
        "type": 1
      }
    ],
    "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",
    "shippingExternalId": "string",
    "shippingTransportInstruction": "string",
    "totalPriceExclVat": 0,
    "totalPriceInclVat": 0,
    "totalVat": 0
  },
  "request": {
    "orderNumber": "string"
  }
}