1. Overview

These services manage order cancellations, returns, fraud, and payment transactions.

1.1. Version information

Version : 1.0

1.2. License information

License : Use of this file is subject to the terms of your agreement with SAP SE or its affiliates respecting the use of the SAP product for which this file relates.
Terms of service : null

1.3. URI scheme

Host : hostname
BasePath : /ordermanagementwebservices

1.4. Tags

  • oms-orders-controller : Orders Operations

  • oms-returns-controller : Returns Operations

  • oms-workflow-controller : Workflow Operations

2. Paths

2.1. Submits an order to the system

POST /orders

2.1.1. Parameters

Type Name Description Schema Default

Query

fields
optional

Fields mapping level

string

"DEFAULT"

Body

orderRequestWsDTO
required

The OrderRequestWsDTO that contains all information for a new order

OrderRequestWsDTO

2.1.2. Responses

HTTP Code Description Schema

201

Created

Order

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.1.3. Consumes

  • application/xml

  • application/json

2.1.4. Produces

  • application/xml

  • application/json

2.1.5. Tags

  • oms-orders-controller

2.2. Finds all orders in the system

GET /orders

2.2.1. Parameters

Type Name Description Schema Default

Query

currentPage
optional

Current page number

integer (int32)

0

Query

fields
optional

Fields mapping level

string

"DEFAULT"

Query

pageSize
optional

Number of items to be displayed per page

integer (int32)

10

Query

sort
optional

Method in which to sort results

string

"asc"

2.2.2. Responses

HTTP Code Description Schema

200

OK

OrderSearchPageWsDto

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.2.3. Produces

  • */*

2.2.4. Tags

  • oms-orders-controller

2.3. Finds a list of all cancellation reasons

GET /orders/cancel-reasons

2.3.1. Responses

HTTP Code Description Schema

200

OK

CancelReasonListWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.3.2. Produces

  • */*

2.3.3. Tags

  • oms-orders-controller

2.4. Finds a paginated list of orders for a given set of order statuses

GET /orders/status/{orderStatuses}

2.4.1. Parameters

Type Name Description Schema Default

Path

orderStatuses
required

List of desired order statuses

string

Query

currentPage
optional

Current page number

integer (int32)

0

Query

fields
optional

Fields mapping level

string

"DEFAULT"

Query

pageSize
optional

Number of items to be displayed per page

integer (int32)

10

Query

sort
optional

Method in which to sort results

string

"asc"

2.4.2. Responses

HTTP Code Description Schema

200

OK

OrderSearchPageWsDto

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.4.3. Produces

  • */*

2.4.4. Tags

  • oms-orders-controller

2.5. Finds a list of all possible order statuses in the system

GET /orders/statuses

2.5.1. Responses

HTTP Code Description Schema

200

OK

OrderStatusListWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.5.2. Produces

  • */*

2.5.3. Tags

  • oms-orders-controller

2.6. Finds a single order by a given order code

GET /orders/{code}

2.6.1. Parameters

Type Name Description Schema Default

Path

code
required

The order code

string

Query

fields
optional

Fields mapping level

string

"DEFAULT"

2.6.2. Responses

HTTP Code Description Schema

200

OK

Order

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.6.3. Produces

  • */*

2.6.4. Tags

  • oms-orders-controller

2.7. Creates an order cancellation in the system

POST /orders/{code}/cancel

2.7.1. Parameters

Type Name Description Schema

Path

code
required

Order code

string

Body

orderCancelRequestWsDTO
required

The OrderCancelRequestWsDTO holding the information of the order we want to cancel

OrderCancelRequestWsDTO

2.7.2. Responses

HTTP Code Description Schema

201

Created

OrderCancelRequestData

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.7.3. Consumes

  • application/xml

  • application/json

2.7.4. Produces

  • application/xml

  • application/json

2.7.5. Tags

  • oms-orders-controller

2.8. Finds a paginated list of order entries for the order with the given code

GET /orders/{code}/entries

2.8.1. Parameters

Type Name Description Schema Default

Path

code
required

Order code

string

Query

currentPage
optional

Current page number

integer (int32)

0

Query

fields
optional

Fields mapping level

string

"DEFAULT"

Query

pageSize
optional

Number of items to display per page

integer (int32)

10

Query

sort
optional

Method in which to sort results

string

"asc"

2.8.2. Responses

HTTP Code Description Schema

200

OK

OrderEntrySearchPageWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.8.3. Produces

  • */*

2.8.4. Tags

  • oms-orders-controller

2.9. Finds the order entry corresponding to the given entry number for the order with the given code

GET /orders/{code}/entries/{entryNumber}

2.9.1. Parameters

Type Name Description Schema Default

Path

code
required

Order code

string

Path

entryNumber
required

Order entry number

string

Query

fields
optional

Fields mapping level

string

"DEFAULT"

2.9.2. Responses

HTTP Code Description Schema

200

OK

OrderEntry

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.9.3. Produces

  • */*

2.9.4. Tags

  • oms-orders-controller

2.10. Finds a list of all fraud reports for an order with the given code

GET /orders/{code}/fraud-reports

2.10.1. Parameters

Type Name Description Schema Default

Path

code
required

Order code

string

Query

fields
optional

Fields mapping level

string

"DEFAULT"

2.10.2. Responses

HTTP Code Description Schema

200

OK

FraudReportListWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.10.3. Produces

  • */*

2.10.4. Tags

  • oms-orders-controller

2.11. Approves an order that could potentially be fraudulent

POST /orders/{code}/fraud-reports/approve

2.11.1. Parameters

Type Name Description Schema

Path

code
required

Order code

string

2.11.2. Responses

HTTP Code Description Schema

200

OK

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.11.3. Consumes

  • application/json

2.11.4. Produces

  • */*

2.11.5. Tags

  • oms-orders-controller

2.12. Rejects an order that could be potentially fraudulent

POST /orders/{code}/fraud-reports/reject

2.12.1. Parameters

Type Name Description Schema

Path

code
required

Order code

string

2.12.2. Responses

HTTP Code Description Schema

200

OK

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.12.3. Consumes

  • application/json

2.12.4. Produces

  • */*

2.12.5. Tags

  • oms-orders-controller

2.13. Moves an order out of the waiting step after tax commit has failed.

POST /orders/{code}/manual/commit-tax

2.13.1. Parameters

Type Name Description Schema

Path

code
required

code

string

2.13.2. Responses

HTTP Code Description Schema

200

OK

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.13.3. Consumes

  • application/xml

  • application/json

2.13.4. Produces

  • application/xml

  • application/json

2.13.5. Tags

  • oms-orders-controller

2.14. Moves an order out of the waiting step after delivery cost tax commit has failed, indicating tax was committed.

POST /orders/{code}/manual/delivery-cost-commit

2.14.1. Parameters

Type Name Description Schema

Path

code
required

Order code

string

2.14.2. Responses

HTTP Code Description Schema

200

OK

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.14.3. Consumes

  • application/xml

  • application/json

2.14.4. Produces

  • application/xml

  • application/json

2.14.5. Tags

  • oms-orders-controller

2.15. Moves an order out of the waiting step after payment reauthorization has failed, indicating payment was reauthorized.

POST /orders/{code}/manual/reauth-payment

2.15.1. Parameters

Type Name Description Schema

Path

code
required

Order code

string

2.15.2. Responses

HTTP Code Description Schema

200

OK

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.15.3. Consumes

  • application/xml

  • application/json

2.15.4. Produces

  • application/xml

  • application/json

2.15.5. Tags

  • oms-orders-controller

2.16. Moves an order out of the waiting step after tax requote has failed.

POST /orders/{code}/manual/requote-tax

2.16.1. Parameters

Type Name Description Schema

Path

code
required

code

string

2.16.2. Responses

HTTP Code Description Schema

200

OK

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.16.3. Consumes

  • application/xml

  • application/json

2.16.4. Produces

  • application/xml

  • application/json

2.16.5. Tags

  • oms-orders-controller

2.17. Moves an order out of the waiting step after payment authorization cancellation has failed, indicating payment was voided.

POST /orders/{code}/manual/void-payment

2.17.1. Parameters

Type Name Description Schema

Path

code
required

Order code

string

2.17.2. Responses

HTTP Code Description Schema

200

OK

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.17.3. Consumes

  • application/xml

  • application/json

2.17.4. Produces

  • application/xml

  • application/json

2.17.5. Tags

  • oms-orders-controller

2.18. Moves an order out of the waiting step after tax post void has failed.

POST /orders/{code}/manual/void-tax

2.18.1. Parameters

Type Name Description Schema

Path

code
required

code

string

2.18.2. Responses

HTTP Code Description Schema

200

OK

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.18.3. Consumes

  • application/xml

  • application/json

2.18.4. Produces

  • application/xml

  • application/json

2.18.5. Tags

  • oms-orders-controller

2.19. Creates a return request

POST /returns

2.19.1. Parameters

Type Name Description Schema Default

Query

fields
optional

Fields mapping level

string

"DEFAULT"

Body

returnRequestWsDTO
required

The ReturnRequestWsDTO holding all required information to create a return request

ReturnRequestWsDTO

2.19.2. Responses

HTTP Code Description Schema

201

Created

ReturnRequestWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.19.3. Consumes

  • application/xml

  • application/json

2.19.4. Produces

  • application/xml

  • application/json

2.19.5. Tags

  • oms-returns-controller

2.20. Finds a paginated list of all the returns in the system

GET /returns

2.20.1. Parameters

Type Name Description Schema Default

Query

currentPage
optional

Current page number

integer (int32)

0

Query

fields
optional

Fields mapping level

string

"DEFAULT"

Query

pageSize
optional

Number of items to be displayed per page

integer (int32)

10

Query

sort
optional

Method in which to sort results

string

"asc"

2.20.2. Responses

HTTP Code Description Schema

200

OK

ReturnSearchPageWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.20.3. Produces

  • */*

2.20.4. Tags

  • oms-returns-controller

2.21. Finds a list of all possble return actions

GET /returns/actions

2.21.1. Responses

HTTP Code Description Schema

200

OK

ReturnActionListWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.21.2. Produces

  • */*

2.21.3. Tags

  • oms-returns-controller

2.22. Cancels a return request

POST /returns/cancel

2.22.1. Parameters

Type Name Description Schema

Body

cancelReturnRequestWsDTO
required

The CancelReturnRequestWsDTO containing information about the return request cancellation

CancelReturnRequestWsDTO

2.22.2. Responses

HTTP Code Description Schema

200

OK

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.22.3. Consumes

  • application/xml

  • application/json

2.22.4. Produces

  • application/xml

  • application/json

2.22.5. Tags

  • oms-returns-controller

2.23. Finds a list of all possible return cancellation reasons

GET /returns/cancel-reasons

2.23.1. Responses

HTTP Code Description Schema

200

OK

CancelReasonListWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.23.2. Produces

  • */*

2.23.3. Tags

  • oms-returns-controller

2.24. Finds a list of all possible refund reasons

GET /returns/refund-reasons

2.24.1. Responses

HTTP Code Description Schema

200

OK

RefundReasonListWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.24.2. Produces

  • */*

2.24.3. Tags

  • oms-returns-controller

2.25. Finds a paginated list of returns with one of a set of desired statuses

GET /returns/status/{returnStatuses}

2.25.1. Parameters

Type Name Description Schema Default

Path

returnStatuses
required

Set of desired return statuses

string

Query

currentPage
optional

Current page number

integer (int32)

0

Query

fields
optional

Fields mapping level

string

"DEFAULT"

Query

pageSize
optional

Number of items to be displayed per page

integer (int32)

10

Query

sort
optional

Method in which to sort results

string

"asc"

2.25.2. Responses

HTTP Code Description Schema

200

OK

ReturnSearchPageWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.25.3. Produces

  • */*

2.25.4. Tags

  • oms-returns-controller

2.26. Finds a list of all return possible return statuses

GET /returns/statuses

2.26.1. Responses

HTTP Code Description Schema

200

OK

ReturnStatusListWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.26.2. Produces

  • */*

2.26.3. Tags

  • oms-returns-controller

2.27. Finds a specific return request by its code

GET /returns/{code}

2.27.1. Parameters

Type Name Description Schema Default

Path

code
required

Return request code

string

Query

fields
optional

Fields mapping level

string

"DEFAULT"

2.27.2. Responses

HTTP Code Description Schema

200

OK

ReturnRequestWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.27.3. Produces

  • */*

2.27.4. Tags

  • oms-returns-controller

2.28. Updates a return request corresponding to the given code with the modifications provided

PUT /returns/{code}

2.28.1. Parameters

Type Name Description Schema Default

Path

code
required

Return request code

string

Query

fields
optional

Fields mapping level

string

"DEFAULT"

Body

returnRequestModificationWsDTO
required

The ReturnRequestModificationWsDTO containing the desired modifications to be applied

ReturnRequestModificationWsDTO

2.28.2. Responses

HTTP Code Description Schema

200

OK

ReturnRequestWsDTO

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.28.3. Consumes

  • application/xml

  • application/json

2.28.4. Produces

  • application/xml

  • application/json

2.28.5. Tags

  • oms-returns-controller

2.29. Approves a return request corresponding to the given code

POST /returns/{code}/approve

2.29.1. Parameters

Type Name Description Schema

Path

code
required

Return request code

string

2.29.2. Responses

HTTP Code Description Schema

200

OK

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.29.3. Consumes

  • application/json

2.29.4. Produces

  • */*

2.29.5. Tags

  • oms-returns-controller

2.30. Finds a paginated list of return entries for a return request corresponding to the given code

GET /returns/{code}/entries

2.30.1. Parameters

Type Name Description Schema Default

Path

code
required

Return request code

string

Query

currentPage
optional

Current page number

integer (int32)

0

Query

fields
optional

Fields mapping level

string

"DEFAULT"

Query

pageSize
optional

Number of items to display per page

integer (int32)

10

Query

sort
optional

Method in which to sort results

string

"asc"

2.30.2. Responses

HTTP Code Description Schema

200

OK

ReturnEntrySearchPageWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.30.3. Produces

  • */*

2.30.4. Tags

  • oms-returns-controller

2.31. Requests manual reversal of the payment for a return

POST /returns/{code}/manual/reverse-payment

2.31.1. Parameters

Type Name Description Schema

Path

code
required

Return request code

string

2.31.2. Responses

HTTP Code Description Schema

200

OK

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.31.3. Consumes

  • application/json

2.31.4. Produces

  • */*

2.31.5. Tags

  • oms-returns-controller

2.32. Requests manual reversal of the taxes for a return

POST /returns/{code}/manual/reverse-tax

2.32.1. Parameters

Type Name Description Schema

Path

code
required

Return request code

string

2.32.2. Responses

HTTP Code Description Schema

200

OK

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.32.3. Consumes

  • application/json

2.32.4. Produces

  • */*

2.32.5. Tags

  • oms-returns-controller

2.33. Finds all active workflow actions for the current user

GET /workflows/actions

2.33.1. Responses

HTTP Code Description Schema

200

OK

WorkflowActionListWsDto

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.33.2. Produces

  • */*

2.33.3. Tags

  • oms-workflow-controller

2.34. Performs the workflow actions belonging to a list of workflows with the provided decision.

POST /workflows/decide-action/{workflowDecisionCode}

2.34.1. Parameters

Type Name Description Schema Default

Path

workflowDecisionCode
required

Workflow Decision code

string

Query

fields
optional

Fields mapping level

string

"DEFAULT"

Body

workflowCodesListWsDto
required

The DecideWorkflowActionsRequestWsDto containing information for deciding workflow actions

WorkflowCodesListWsDto

2.34.2. Responses

HTTP Code Description Schema

200

OK

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.34.3. Consumes

  • application/xml

  • application/json

2.34.4. Produces

  • application/xml

  • application/json

2.34.5. Tags

  • oms-workflow-controller

2.35. Performs the workflow actions with the provided decision.

POST /workflows/{workflowCode}/{workflowDecisionCode}

2.35.1. Parameters

Type Name Description Schema

Path

workflowCode
required

Workflow code

string

Path

workflowDecisionCode
required

Workflow Decision code

string

2.35.2. Responses

HTTP Code Description Schema

200

OK

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.35.3. Consumes

  • application/xml

  • application/json

2.35.4. Produces

  • application/xml

  • application/json

2.35.5. Tags

  • oms-workflow-controller

3. Definitions

3.1. Address

Request body fields required and optional to operate on address data. The DTO is in XML or .json format

Name Description Schema

cellphone
optional

Cellphone number

string

companyName
optional

Company Name

string

country
optional

Country where address is located

Country

defaultAddress
optional

Boolean flag if address is default

boolean

district
optional

District name

string

email
optional

Email address

string

firstName
required

First name of the address person

string

formattedAddress
optional

Boolean flag if address is formatted

string

id
optional

Unique id value of the address which is optional while creating new address. While performing other address operations this value is the key

string

lastName
required

Last name of the address person

string

line1
required

First line of the address

string

line2
optional

Second line of the address

string

phone
optional

Phone number

string

postalCode
required

Postal code of the address

string

region
optional

Region where address belongs to

Region

shippingAddress
optional

Boolean flag if address is for shipping

boolean

title
optional

Title of the address person

string

titleCode
required

Code of the title

string

town
required

Town, field required

string

visibleInAddressBook
optional

Boolean flag if address is visible in the Address Book

boolean

3.2. BaseOption

Representation of a Base Ooption

Name Description Schema

options
optional

List of all variant options

< VariantOption > array

selected
optional

Variant option selected

VariantOption

variantType
optional

Variant type of base option

string

3.3. CancelReason

Name Schema

code
optional

string

type
optional

string

3.4. CancelReasonListWsDTO

Name Schema

reasons
optional

< string > array

3.5. CancelReturnRequestWsDTO

Name Schema

cancelReason
optional

string

code
optional

string

notes
optional

string

3.6. CardType

Representation of a Card Type

Name Description Schema

code
optional

Card type code

string

name
optional

Card type name

string

3.7. Category

Representation of a Category

Name Description Schema

code
optional

Code of the category

string

image
optional

Category image

Image

name
optional

Name of the category

string

url
optional

URL of the category

string

3.8. Classification

Representation of a Classification

Name Description Schema

code
optional

Code of the classification

string

features
optional

List of features for given classification

< Feature > array

name
optional

Name of the classification

string

3.9. ConfigurationInfo

Representation of a Configuration Info

Name Description Schema

configurationLabel
optional

Label of configuration info

string

configurationValue
optional

Value of configuration info

string

configuratorType
optional

Type of configuration info

string

status
optional

Status of configuration info

string

3.10. Consignment

Representation of a Consignment

Name Description Schema

code
optional

Consignment code

string

deliveryMode
optional

DeliveryMode

deliveryPointOfService
optional

Delivery point of service

PointOfService

entries
optional

List of consignment entries

< ConsignmentEntry > array

orderCode
optional

string

packagingInfo
optional

PackagingInfoWsDTO

shippingAddress
optional

Shipping address

Address

shippingDate
optional

string (date-time)

status
optional

Consignment status

string

statusDate
optional

Consignment status date

string (date-time)

statusDisplay
optional

Consignment status display

string

trackingID
optional

Consignment tracking identifier

string

warehouseCode
optional

string

3.11. ConsignmentEntry

Representation of a Consignment Entry

Name Description Schema

orderEntry
optional

Order entry of Consignment entry

OrderEntry

quantity
optional

Quantity value of Consignment entry

integer (int64)

quantityDeclined
optional

integer (int64)

quantityPending
optional

integer (int64)

quantityShipped
optional

integer (int64)

shippedQuantity
optional

Shipped quantity

integer (int64)

3.12. Country

Response body fields which will be returned while fetching the list of countries. The DTO is in XML or .json format

Name Description Schema

isocode
optional

Country code in iso format

string

name
optional

Name of the country

string

3.13. Currency

Representation of a Currency

Name Description Schema

active
optional

Boolean flag whether currency is active

boolean

isocode
optional

Code of the currency in iso format

string

name
optional

Name of the currency

string

symbol
optional

Symbol of the currency

string

3.14. DeliveryMode

Representation of a Delivery mode

Name Description Schema

code
optional

Code of the delivery mode

string

deliveryCost
optional

Cost of the delivery

Price

description
optional

Description of the delivery mode

string

name
optional

Name of the delivery mode

string

3.15. DeliveryOrderEntryGroup

Representation of a Delivery Order Entry Group

Name Description Schema

deliveryAddress
optional

Delivery address for order entry group

Address

entries
optional

List of order entries

< OrderEntry > array

quantity
optional

Quantity of order entries in a group

integer (int64)

totalPriceWithTax
optional

Total price with tax

Price

3.16. EntryGroup

Representation of an Entry Group

Name Description Schema

entries
optional

List of order entries

< OrderEntry > array

entryGroupNumber
optional

Identifier of the entry group
Example : 1

integer (int32)

entryGroups
optional

List of child entry groups

< EntryGroup > array

erroneous
optional

Indicates if the entry group is in an error state
Example : true

boolean

label
optional

Label for the entry group
Example : "Photo On The Go Package"

string

type
optional

Indicates type of the group, possible values are STANDALONE, CONFIGURABLEBUNDLE or any customer implemented type for any new provider
Example : "STANDALONE"

string

3.17. Feature

Representation of a Feature

Name Description Schema

code
optional

Code of the feature

string

comparable
optional

Flag defining it feature is comparable

boolean

description
optional

Description of the feature

string

featureUnit
optional

Feature unit

FeatureUnit

featureValues
optional

List of feature values

< FeatureValue > array

name
optional

Name of the feature

string

range
optional

Range number of the reature

boolean

type
optional

Type of the feature

string

3.18. FeatureUnit

Representation of a Feature Unit

Name Description Schema

name
optional

Name of the feature unit

string

symbol
optional

Symbol of the feature unit

string

unitType
optional

Type of the feature unit

string

3.19. FeatureValue

Representation of a Feature Value

Name Description Schema

value
optional

Value of the feature

string

3.20. FraudReportListWsDTO

Name Schema

reports
optional

< FraudReportWsDTO > array

3.21. FraudReportWsDTO

Name Schema

explanation
optional

string

fraudSymptomScorings
optional

< FraudSymptomScoringsWsDTO > array

provider
optional

string

status
optional

string

timestamp
optional

string (date-time)

3.22. FraudSymptomScoringsWsDTO

Name Schema

explanation
optional

string

name
optional

string

score
optional

number (double)

3.23. FutureStock

Representation of a Future Stock

Name Description Schema

date
optional

Date of future stock

string (date-time)

formattedDate
optional

Date of future stock expressed in text value

string

stock
optional

Stock information of future stock

Stock

3.24. GeoPoint

Representation of a GeoPoint

Name Description Schema

latitude
optional

Geopoint latitude

number (double)

longitude
optional

Geopoint longitude

number (double)

3.25. Image

Representation of an Image

Name Description Schema

altText
optional

Tooltip content which is visible while image mouse hovering

string

format
optional

Format of the image, can be zoom, product, thumbnail, store, cartIcon, etc.

string

galleryIndex
optional

Index of the image while displayed in gallery

integer (int32)

imageType
optional

Type of the image, can be PRIMARY or GALLERY

enum (PRIMARY, GALLERY)

url
optional

URL address of the image

string

3.26. Language

Representation of a Language

Name Description Schema

active
optional

true/false indicator when the language is active

boolean

isocode
optional

iso code of the language

string

name
optional

name of the language

string

nativeName
optional

name the language in native form

string

3.27. OpeningSchedule

Representation of an Opening schedule

Name Description Schema

code
optional

Code of the opening schedule

string

name
optional

Name of the opening schedule

string

specialDayOpeningList
optional

List of special opening days

< SpecialOpeningDay > array

weekDayOpeningList
optional

List of weekday opening days

< WeekdayOpeningDay > array

3.28. Order

Representation of an Order

Name Description Schema

appliedOrderPromotions
optional

List of applied order promotions

< PromotionResult > array

appliedProductPromotions
optional

List of applied product promotions

< PromotionResult > array

appliedVouchers
optional

List of applied vouchers

< Voucher > array

calculated
optional

Flag showing if order is calculated

boolean

cancellable
optional

Boolean flag showing if order is cancellable
Example : true

boolean

code
optional

Code number of order

string

consignments
optional

List of consignment

< Consignment > array

created
optional

Date of order creation

string (date-time)

deliveryAddress
optional

Delivery address

Address

deliveryCost
optional

Delivery cost

Price

deliveryItemsQuantity
optional

Quantity of delivery items

integer (int64)

deliveryMode
optional

Delivery mode information

DeliveryMode

deliveryOrderGroups
optional

List of delivery order entries group

< DeliveryOrderEntryGroup > array

deliveryStatus
optional

Order delivery status

string

deliveryStatusDisplay
optional

Order delivery status display

string

entries
optional

List of order entries

< OrderEntry > array

entryGroups
optional

List of entry groups

< EntryGroup > array

guestCustomer
optional

Flag showing if customer is Guest customer

boolean

guid
optional

Guest user id identifier

string

net
optional

Flag stating iv value is net-value

boolean

orderDiscounts
optional

Order discounts

Price

paymentAddress
optional

Address

paymentInfo
optional

Payment information

PaymentDetails

pickupItemsQuantity
optional

Quantity of pickup items

integer (int64)

pickupOrderGroups
optional

List of pickup order entry group

< PickupOrderEntryGroup > array

productDiscounts
optional

Product discounts

Price

returnable
optional

Boolean flag showing if order is returnable
Example : true

boolean

site
optional

Site

string

status
optional

Status of order

string

statusDisplay
optional

Status display

string

store
optional

Store

string

subTotal
optional

Subtotal price

Price

totalDiscounts
optional

Total discounts

Price

totalItems
optional

integer (int32)

totalPrice
optional

Total price value

Price

totalPriceWithTax
optional

Total price with tax

Price

totalTax
optional

Total tax price

Price

unconsignedEntries
optional

List of unconsigned order entries

< OrderEntry > array

user
optional

User information

Principal

3.29. OrderCancelEntryData

Name Schema

cancelQuantity
optional

integer (int64)

cancelReason
optional

CancelReason

notes
optional

string

orderEntryNumber
optional

integer (int32)

3.30. OrderCancelEntryWsDTO

Name Schema

cancelQuantity
optional

integer (int64)

cancelReason
optional

string

notes
optional

string

orderEntryNumber
optional

string

3.31. OrderCancelRecordEntryWsDTO

Name Schema

cancelResult
optional

string

refusedMessage
optional

string

3.32. OrderCancelRequestData

Name Schema

entries
optional

< OrderCancelEntryData > array

orderCode
optional

string

userId
optional

string

3.33. OrderCancelRequestWsDTO

Name Schema

entries
optional

< OrderCancelEntryWsDTO > array

userId
optional

string

3.34. OrderEntry

Representation of an Order entry

Name Description Schema

basePrice
optional

Base price of order entry item

Price

cancellableQuantity
optional

Quantity number of cancellable items in order entry
Example : 5

integer (int64)

cancelledItemsPrice
optional

Total price of cancelled items which belong to the order entry item

Price

configurationInfos
optional

Configuration info of order entry

< ConfigurationInfo > array

deliveryMode
optional

Delivery mode

DeliveryMode

deliveryPointOfService
optional

Point of service associated with order entry

PointOfService

entryNumber
optional

Entry number of the order entry

integer (int32)

product
optional

Product details of order entry

Product

quantity
optional

Quantity number of items in order entry

integer (int64)

quantityAllocated
optional

integer (int64)

quantityCancelled
optional

integer (int64)

quantityPending
optional

integer (int64)

quantityReturned
optional

integer (int64)

quantityShipped
optional

integer (int64)

quantityUnallocated
optional

integer (int64)

returnableQuantity
optional

Quantity number of returnable items in order entry
Example : 5

integer (int64)

returnedItemsPrice
optional

Total price of returned items which belong to the order entry item

Price

statusSummaryList
optional

List of aggregated status information per entry, relevant if the entry is configurable and its configuration contains one or many issues in different severities. Note that configurators typically raise such issues only in case the parent document is changeable. In this case the issues (depending on their severity) need to be fixed before a checkout can be done. This means this segment can be present for a cart entry, for order entries it will always be empty

< StatusSummary > array

totalPrice
optional

Total price of order entry item

Price

updateable
optional

Flag defining if order entry item is updateable

boolean

url
optional

string

3.35. OrderEntryRequestWsDTO

Name Schema

basePrice
optional

number (double)

deliveryModeCode
optional

string

deliveryPointOfService
optional

string

entryNumber
optional

string

productCode
optional

string

quantity
optional

integer (int64)

totalPrice
optional

number (double)

unitCode
optional

string

3.36. OrderEntrySearchPageWsDTO

Name Schema

orderEntries
optional

< OrderEntry > array

pagination
optional

deprecatedPagination

sorts
optional

< Sort > array

3.37. OrderRequestWsDTO

Name Schema

allPromotionResults
optional

< PromotionResult > array

calculated
optional

boolean

currencyIsocode
optional

string

deliveryAddress
optional

Address

deliveryCost
optional

number (double)

deliveryModeCode
optional

string

deliveryStatus
optional

string

description
optional

string

entries
optional

< OrderEntryRequestWsDTO > array

expirationTime
optional

string (date-time)

externalOrderCode
optional

string

guid
optional

string

languageIsocode
optional

string

name
optional

string

net
optional

boolean

paymentAddress
optional

Address

paymentTransactions
optional

< PaymentTransactionWsDTO > array

siteUid
optional

string

storeUid
optional

string

subtotal
optional

number (double)

totalPrice
optional

number (double)

totalTax
optional

number (double)

user
optional

User

3.38. OrderSearchPageWsDto

Name Schema

orders
optional

< Order > array

pagination
optional

deprecatedPagination

sorts
optional

< Sort > array

3.39. OrderStatusListWsDTO

Name Schema

statuses
optional

< string > array

3.40. PackagingInfoWsDTO

Name Schema

dimensionUnit
optional

string

grossWeight
optional

string

height
optional

string

insuredValue
optional

string

length
optional

string

weightUnit
optional

string

width
optional

string

3.41. PaymentDetails

Representation of a Payment Details

Name Description Schema

accountHolderName
optional

Name of account holder

string

billingAddress
optional

Address details to be considered as billing address

Address

cardNumber
optional

Payment card number

string

cardType
optional

Type of payment card

CardType

defaultPayment
optional

Flag to mark if payment the default one

boolean

expiryMonth
optional

Month of expiration of payment

string

expiryYear
optional

Year of expiration of payment

string

id
optional

Unique identifier of payment detail

string

issueNumber
optional

Issue number

string

saved
optional

Flag to mark if payment is saved one

boolean

startMonth
optional

Start month from which payment is valid

string

startYear
optional

Start year from which payment is valid

string

subscriptionId
optional

Identifier of subscription

string

3.42. PaymentTransactionEntryWsDTO

Name Schema

amount
optional

number

code
optional

string

currencyIsocode
optional

string

requestId
optional

string

requestToken
optional

string

subscriptionID
optional

string

time
optional

string (date-time)

transactionStatus
optional

string

transactionStatusDetails
optional

string

type
optional

string

versionID
optional

string

3.43. PaymentTransactionWsDTO

Name Schema

code
optional

string

currencyIsocode
optional

string

entries
optional

< PaymentTransactionEntryWsDTO > array

paymentInfo
optional

PaymentDetails

paymentProvider
optional

string

plannedAmount
optional

number

requestId
optional

string

requestToken
optional

string

versionID
optional

string

3.44. PickupOrderEntryGroup

Representation of a Pickup Order Entry Group

Name Description Schema

deliveryPointOfService
optional

Delivery point of service

PointOfService

distance
optional

Distance calculated to pickup place

number (double)

entries
optional

List of order entries

< OrderEntry > array

quantity
optional

Quantity of order entries in a group

integer (int64)

totalPriceWithTax
optional

Total price with tax

Price

3.45. PointOfService

Representation of a Point of service

Name Description Schema

address
optional

Address information of point of service

Address

description
optional

Description of the point of service

string

displayName
optional

Display name of the point of service

string

distanceKm
optional

Distance to the point of service as number value

number (double)

features
optional

List of features for a given point of service

< string, string > map

formattedDistance
optional

Distance to the point of service as text value

string

geoPoint
optional

Geopoint localization info about point of service

GeoPoint

mapIcon
optional

Image associated with the point of service

Image

name
optional

Name of the point of service

string

openingHours
optional

Opening hours of point of service

OpeningSchedule

storeContent
optional

Store content of given point of service

string

storeImages
optional

Collection of images associated with a point of service

< Image > array

url
optional

Url address of the point of service

string

warehouseCodes
optional

< string > array

3.46. Price

Representation of a Price

Name Description Schema

currencyIso
optional

Currency iso format

string

formattedValue
optional

Value of price formatted

string

maxQuantity
optional

Maximum quantity of the price value

integer (int64)

minQuantity
optional

Minimum quantity of the price value

integer (int64)

priceType
optional

Type of the price

enum (BUY, FROM)

value
optional

Value of price in BigDecimal format

number

3.47. PriceRange

Representation of a Price Range

Name Description Schema

maxPrice
optional

Maximum value of the Price Range

Price

minPrice
optional

Minium value of the Price Range

Price

3.48. Principal

Representation of a Principal webservice DTO used for defining User data types

Name Description Schema

name
optional

Name of the user

string

uid
optional

Unique user identifier

string

3.49. Product

Representation of a Product

Name Description Schema

availableForPickup
optional

Flag defining if product is available for pickup

boolean

averageRating
optional

Rating number of average value

number (double)

baseOptions
optional

List of base options related to the product

< BaseOption > array

baseProduct
optional

Information about base product

string

categories
optional

List of categories product belongs to

< Category > array

classifications
optional

List of classifications related to the product

< Classification > array

code
optional

Code of the product

string

configurable
optional

Flag stating if product is configurable

boolean

configuratorType
optional

Configurator type related to the product

string

description
optional

Description of the product

string

futureStocks
optional

List of future stocks

< FutureStock > array

images
optional

List of images linked to product

< Image > array

manufacturer
optional

Data of product manufacturer

string

multidimensional
optional

Flag stating if product is multidimentional

boolean

name
optional

Name of the product

string

numberOfReviews
optional

Number of reviews associated with the product

integer (int32)

potentialPromotions
optional

List of potential promotions related to the product

< Promotion > array

price
optional

Price of the product

Price

priceRange
optional

Price range assigned to the product

PriceRange

productReferences
optional

List of product references

< ProductReference > array

purchasable
optional

Flag defining if product is purchasable

boolean

reviews
optional

List of reviews associated with the product

< Review > array

stock
optional

Stock value of the product

Stock

summary
optional

Product summary

string

tags
optional

Tags associated with the product

< string > array

url
optional

Url address of the product

string

variantMatrix
optional

List of variant matrixes associated with the product

< VariantMatrixElement > array

variantOptions
optional

List of variant options related to the product

< VariantOption > array

variantType
optional

Variant type of the product

string

volumePrices
optional

List of volume prices

< Price > array

volumePricesFlag
optional

Flag stating if volume price should be displayed

boolean

3.50. ProductReference

Representation of a Product Reference

Name Description Schema

description
optional

Reference description

string

preselected
optional

Flag stating if product reference is preselected

boolean

quantity
optional

Reference quantity

integer (int32)

referenceType
optional

Reference type

string

target
optional

Target product

Product

3.51. Promotion

Representation of a Promotion

Name Description Schema

code
optional

Code of the promotion

string

couldFireMessages
optional

Message about promotion which is displayed when planning potential promotion. This field has higher priority over promotion description

< string > array

description
optional

Description of the promotion

string

enabled
optional

Boolean flag if promotion is enabled

boolean

endDate
optional

Last date of validity of the promotion

string (date-time)

firedMessages
optional

Message fired while the promotion is active. This is info how much you will get when applying the promotion

< string > array

priority
optional

Priority index as numeric value of the promotion. Higher number means higher priority

integer (int32)

productBanner
optional

Image banner of the promotion

Image

promotionGroup
optional

Group of the promotion

string

promotionType
optional

Type of the promotion

string

restrictions
optional

List of promotion restrictions

< PromotionRestriction > array

startDate
optional

The initial date of the promotion

string (date-time)

title
optional

Promotion title

string

3.52. PromotionOrderEntryConsumed

Representation of a Promotion order entry consumed

Name Description Schema

adjustedUnitPrice
optional

Adjusted unit price for promotion order entry

number (double)

code
optional

Order entry code

string

orderEntryNumber
optional

Order entry number

integer (int32)

quantity
optional

Quantity of promotion order entry

integer (int64)

3.53. PromotionRestriction

Representation of a Promotion Restriction

Name Description Schema

description
optional

Description of the promotion restriction

string

restrictionType
optional

Type of the promotion restriction

string

3.54. PromotionResult

Representation of a Promotion result

Name Description Schema

consumedEntries
optional

List of promotion order entries consumed

< PromotionOrderEntryConsumed > array

description
optional

Description of promotion result

string

promotion
optional

Promotion information for given promotion result

Promotion

3.55. RefundReasonListWsDTO

Name Schema

refundReasons
optional

< string > array

3.56. Region

Response body fields which will be returned while fetching the list of country’s regions.

Name Description Schema

countryIso
optional

Country code in iso format

string

isocode
optional

Country and Region code in iso format

string

isocodeShort
optional

Region code in short iso form

string

name
optional

Name of the region

string

3.57. ReturnActionListWsDTO

Name Schema

returnActions
optional

< string > array

3.58. ReturnEntryModificationWsDTO

Name Schema

deliveryModeCode
optional

string

productCode
optional

string

refundAmount
optional

number

3.59. ReturnEntrySearchPageWsDTO

Name Schema

pagination
optional

deprecatedPagination

returnEntries
optional

< ReturnEntryWsDTO > array

sorts
optional

< Sort > array

3.60. ReturnEntryWsDTO

Name Schema

action
optional

string

expectedQuantity
optional

integer (int64)

notes
optional

string

orderEntry
optional

OrderEntry

reachedDate
optional

string (date-time)

receivedQuantity
optional

integer (int64)

refundAmount
optional

Price

refundReason
optional

string

refundedDate
optional

string (date-time)

replacementReason
optional

string

3.61. ReturnRequestModificationWsDTO

Name Schema

refundDeliveryCost
optional

boolean

returnEntries
optional

< ReturnEntryModificationWsDTO > array

3.62. ReturnRequestWsDTO

Name Schema

code
optional

string

deliveryCost
optional

Price

order
optional

Order

refundDeliveryCost
optional

boolean

returnEntries
optional

< ReturnEntryWsDTO > array

rma
optional

string

status
optional

string

3.63. ReturnSearchPageWsDTO

Name Schema

pagination
optional

deprecatedPagination

returns
optional

< ReturnRequestWsDTO > array

sorts
optional

< Sort > array

3.64. ReturnStatusListWsDTO

Name Schema

statuses
optional

< string > array

3.65. Review

Representation of a Review

Name Description Schema

alias
optional

Alias name for the review

string

comment
optional

Review comment

string

date
optional

Date of the review

string (date-time)

headline
optional

Review headline

string

id
optional

Identifier of review

string

principal
optional

Person related to the review

User

rating
optional

Review rating value

number (double)

3.66. Sort

Representation a Sort option

Name Description Schema

code
optional

Code of Sort

string

name
optional

Name of Sort

string

selected
optional

Flag stating when Sort is selected

boolean

3.67. SpecialOpeningDay

Representation of a special opening day

Name Description Schema

closed
optional

Flag stating if special opening day is closed

boolean

closingTime
optional

Closing time of opening day

Time

comment
optional

Comment field

string

date
optional

Date of special opening day

string (date-time)

formattedDate
optional

Text representation of the date of special opening day

string

name
optional

Name of the special opening day event

string

openingTime
optional

Starting time of opening day

Time

3.68. StatusSummary

Representation of a status summary, an aggregated view on issues for a specific status or severity. These issues are attached to configurations of products or order entries

Name Description Schema

numberOfIssues
optional

Number of issues per status
Example : 3

integer (int32)

status
optional

Status or severity indicator, can be one of ERROR, WARNING, INFO or SUCCESS
Example : "ERROR"

string

3.69. Stock

Representation of a Stock

Name Description Schema

isValueRounded
optional

Indicate whether Stock level value is rounded

boolean

stockLevel
optional

Stock level expressed as number

integer (int64)

stockLevelStatus
optional

Status of stock level

string

3.70. Time

Representation of a Time

Name Description Schema

formattedHour
optional

Formatted hour

string

hour
optional

Hour part of the time data
Minimum value : -128
Maximum value : 127

integer (int32)

minute
optional

Minute part of the time data
Minimum value : -128
Maximum value : 127

integer (int32)

3.71. User

Representation of an User

Name Description Schema

currency
optional

User preferred currency

Currency

customerId
optional

Customer identifier

string

deactivationDate
optional

Deactivation date

string (date-time)

defaultAddress
optional

User address

Address

displayUid
optional

User identifier

string

firstName
optional

User first name

string

language
optional

User preferred language

Language

lastName
optional

User last name

string

name
optional

Name of the user

string

title
optional

User title

string

titleCode
optional

User title code

string

uid
optional

Unique user identifier

string

3.72. VariantCategory

Representation of a Variant Category

Name Description Schema

hasImage
optional

Flag if varian category has image assigned

boolean

name
optional

Variant category name

string

priority
optional

Priority number of variant category

integer (int32)

3.73. VariantMatrixElement

Representation of a Variant Matrix Element

Name Description Schema

elements
optional

List of elements with the type of variant matrix element

< VariantMatrixElement > array

isLeaf
optional

boolean

parentVariantCategory
optional

Parent variant category for variant matrix element

VariantCategory

variantOption
optional

Variant option for variant matrix element

VariantOption

variantValueCategory
optional

Variant value category for variant matrix element

VariantValueCategory

3.74. VariantOption

Representation of a Variant Option

Name Description Schema

code
optional

Code of the variant option

string

priceData
optional

Price data information of the variant option

Price

stock
optional

Stock value of the variant option

Stock

url
optional

Url address of the variant option

string

variantOptionQualifiers
optional

List of variant option qualifiers

< VariantOptionQualifier > array

3.75. VariantOptionQualifier

Representation of a Variant Option Qualifier

Name Description Schema

image
optional

Image associated with variant option qualifier

Image

name
optional

Name of variant option qualifier

string

qualifier
optional

Qualifier

string

value
optional

Value of variant option qualifier

string

3.76. VariantValueCategory

Representation of a Variant Value Category

Name Description Schema

name
optional

Name of the variant value category

string

sequence
optional

Sequence number of variant value category

integer (int32)

superCategories
optional

Parent category of variant value category

< VariantCategory > array

3.77. Voucher

Representation of a Voucher

Name Description Schema

appliedValue
optional

Applied value when using this voucher

Price

code
optional

The identifier of the Voucher. This is the first part of voucher code which holds first 3 letters, like: 123

string

currency
optional

Currency of the voucher

Currency

description
optional

Description of the voucher

string

freeShipping
optional

Specifies if the order this voucher is applied to is shipped for free (true) or not (false). Defaults to false.

boolean

name
optional

Name of the voucher

string

value
optional

Value of the voucher. Example of such value is: 15.0d

number (double)

valueFormatted
optional

Formatted value of the voucher

string

valueString
optional

The value of the voucher to display. Example: 15.0%

string

voucherCode
optional

Voucher code, is the holder for keeping specific occasional voucher related to business usage. It can be generated and looks like: 123-H8BC-Y3D5-34AL

string

3.78. WeekdayOpeningDay

Representation of a Weekday Opening Day

Name Description Schema

closed
optional

Flag stating if weekday opening day is closed

boolean

closingTime
optional

Closing time of opening day

Time

openingTime
optional

Starting time of opening day

Time

weekDay
optional

Text representation of week day opening day

string

3.79. WorkflowActionAttachmentItemData

Name Schema

code
optional

string

orderCode
optional

string

3.80. WorkflowActionListWsDto

Name Schema

workflowActions
optional

< WorkflowActionWsDto > array

3.81. WorkflowActionWsDto

Name Schema

attachmentItems
optional

< WorkflowActionAttachmentItemData > array

code
optional

string

comment
optional

string

creationTime
optional

string (date-time)

description
optional

string

name
optional

string

workflowCode
optional

string

3.82. WorkflowCodesListWsDto

Name Schema

codes
optional

< string > array

3.83. deprecatedPagination

Representation of a search results pagination

Name Description Schema

currentPage
optional

The current page number. The first page is number zero (0), the second page is number one (1), and so on

integer (int32)

pageSize
optional

The number of results per page. A page may have less results if there are less than a full page of results, only on the last page in the results

integer (int32)

sort
optional

The selected sort code

string

totalPages
optional

The total number of pages. This is the number of pages, each of pageSize, required to display the totalResults.

integer (int32)

totalResults
optional

The total number of matched results across all pages

integer (int64)