GetReturnOrderDetail (REST)

Description

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

REST API:

URL: /Shoxl/v1/GetReturnOrderDetail Method: POST

Request body:

GetReturnOrderDetailRequest{

Parameter

Type

Description

accountNumber

string required

The (project) account number of the customer.

orderNumber

string required

The Shoxl Shop unique order number

}

Example:

{
  "accountNumber": "string",
  "orderNumber": "string"
}

Response body:

GetReturnOrderDetailResult{

Parameter

Type

Description

errorCode

string nullable: true

An Error code returned by the ERP system

errorDescription

string nullable: true

The error description related to the error code returned by the ERP system

order

ReturnOrderDetail

Object containing the return order detail information.

request

GetReturnOrderDetailRequest

The request sent by the Shoxl Shop.

}

ReturnOrderDetail{

Parameter

Type

Description

orderNumber

string nullable: true

The Shoxl Shop unique order number

orderLines

[ReturnOrderLine]

A list of ReturnOrderLine objects.

}

ReturnOrderLine{

Parameter

Type

Description

productNumber

string nullable: true

The product number

description

string nullable: true

The default description of the product

quantity

number($double)

The number of items returned

baseUnit

string nullable: true

The base unit of the product, eg pce or meter.

orderLineState

integer($int32)

The status of the return order line, 0 = ToReturn, 1 = PartiallyReturned, 2 = Returned, 3 = Credited, 4 = Cancelled

}

Example:

{
  "customerNumber": "string",
  "errorCode": "string",
  "errorDescription": "string",
  "order": {
    "orderNumber": "string",
    "orderLines": [
      {
        "productNumber": "string",
        "description": "string",
        "quantity": 0,
        "baseUnit": "string",
        "orderLineState": 0
      }
    ]
  },
  "request": {
    "accountNumber": "string",
    "orderNumber": "string"
  }
}

Last updated