1. Overview

These services manage consignments, stock levels, and points of service.

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 : /warehousingwebservices

1.4. Tags

  • warehousing-asns-controller : Advanced Shipping Notice’s Operations

  • warehousing-base-stores-controller : Base Store’s Operations

  • warehousing-consignments-controller : Consignment’s Operations

  • warehousing-orders-controller : Order’s Operations

  • warehousing-point-of-services-controller : Point of Service Operations

  • warehousing-returns-controller : Return’s Operations

  • warehousing-stock-levels-controller : Stock Level’s Operations

  • warehousing-warehouses-controller : Warehouse’s Operations

2. Paths

2.1. Creates an advanced shipping notice

POST /asns

2.1.1. Parameters

Type Name Description Schema Default

Query

fields
optional

Fields mapping level

string

"DEFAULT"

Body

asnWsDTO
required

AsnWsDTO containing information about the asn to be created

2.1.2. Responses

HTTP Code Description Schema

201

Created

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

  • warehousing-asns-controller

2.2. Cancels an advanced shipping notice

POST /asns/{internalId}/cancel

2.2.1. Parameters

Type Name Description Schema Default

Path

internalId
required

Internal Id for the advanced shipping notice to be cancelled

string

Query

fields
optional

Fields mapping level

string

"DEFAULT"

2.2.2. Responses

HTTP Code Description Schema

201

Created

No Content

202

Accepted

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.2.3. Consumes

  • application/xml

  • application/json

2.2.4. Produces

  • application/xml

  • application/json

2.2.5. Tags

  • warehousing-asns-controller

2.3. Confirms the receipt of an advanced shipping notice

POST /asns/{internalId}/confirm-receipt

2.3.1. Parameters

Type Name Description Schema Default

Path

internalId
required

Internal Id for the advanced shipping notice to be confirmed

string

Query

fields
optional

Fields mapping level

string

"DEFAULT"

2.3.2. Responses

HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.3.3. Consumes

  • application/xml

  • application/json

2.3.4. Produces

  • application/xml

  • application/json

2.3.5. Tags

  • warehousing-asns-controller

2.4. Finds a paginated list of point of services per a given base store

GET /basestores/{uid}/pointofservices

2.4.1. Parameters

Type Name Description Schema Default

Path

uid
required

The id of the base store

string

Query

currentPage
optional

Current page

integer (int32)

0

Query

fields
optional

Fields mapping level

string

"DEFAULT"

Query

pageSize
optional

Page size

integer (int32)

10

Query

sort
optional

Sort parameter

string

"asc"

2.4.2. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.4.3. Produces

  • */*

2.4.4. Tags

  • warehousing-base-stores-controller

2.5. Finds a paginated list of warehouses per a given base store

GET /basestores/{uid}/warehouses

2.5.1. Parameters

Type Name Description Schema Default

Path

uid
required

The id of the base store

string

Query

currentPage
optional

Current page

integer (int32)

0

Query

fields
optional

Fields mapping level

string

"DEFAULT"

Query

pageSize
optional

Page size

integer (int32)

10

Query

sort
optional

Sort parameter

string

"asc"

2.5.2. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.5.3. Produces

  • */*

2.5.4. Tags

  • warehousing-base-stores-controller

2.6. Finds a paginated list of consignments

GET /consignments

2.6.1. Parameters

Type Name Description Schema Default

Query

currentPage
optional

Current page

integer (int32)

0

Query

fields
optional

Fields mapping level

string

"DEFAULT"

Query

pageSize
optional

Page size

integer (int32)

10

Query

sort
optional

Sort parameter

string

"asc"

2.6.2. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.6.3. Produces

  • */*

2.6.4. Tags

  • warehousing-consignments-controller

2.7. Request to pick multiple Consignments and generate a consolidated Pick Slip

POST /consignments/consolidated-pick

2.7.1. Parameters

Type Name Description Schema

Body

consignmentCodes
required

The ConsignmentsCodesWsDTO which contains the Consignment codes

2.7.2. Responses

HTTP Code Description Schema

200

OK

string

201

Created

No Content

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

  • */*

2.7.5. Tags

  • warehousing-consignments-controller

2.8. Finds a list of all decline reasons

GET /consignments/decline-reasons

2.8.1. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.8.2. Produces

  • */*

2.8.3. Tags

  • warehousing-consignments-controller

2.9. Finds a paginated list of consignments for a given consignment status

GET /consignments/status/{consignmentStatuses}

2.9.1. Description

Consignment status is case sensitive

2.9.2. Parameters

Type Name Description Schema Default

Path

consignmentStatuses
required

Consignment status

string

Query

currentPage
optional

Current page

integer (int32)

0

Query

fields
optional

Fields mapping level

string

"DEFAULT"

Query

pageSize
optional

Page size

integer (int32)

10

Query

sort
optional

Sort parameter

string

"asc"

2.9.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.9.4. Produces

  • */*

2.9.5. Tags

  • warehousing-consignments-controller

2.10. Finds a list of all consignment’s statuses

GET /consignments/statuses

2.10.1. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.10.2. Produces

  • */*

2.10.3. Tags

  • warehousing-consignments-controller

2.11. Finds a consignment by a given consignment code

GET /consignments/{code}

2.11.1. Parameters

Type Name Description Schema Default

Path

code
required

The consignment code

string

Query

fields
optional

Fields mapping level

string

"DEFAULT"

2.11.2. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.11.3. Produces

  • */*

2.11.4. Tags

  • warehousing-consignments-controller

2.12. Confirms a consignment’s pickup for a given consignment code

POST /consignments/{code}/confirm-pickup

2.12.1. Parameters

Type Name Description Schema

Path

code
required

The consignment 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/xml

  • application/json

2.12.4. Produces

  • application/xml

  • application/json

2.12.5. Tags

  • warehousing-consignments-controller

2.13. Confirms a consignment’s shipping for a given consignment code

POST /consignments/{code}/confirm-shipping

2.13.1. Parameters

Type Name Description Schema

Path

code
required

The consignment 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

  • warehousing-consignments-controller

2.14. Finds a paginated list of consignment entries for a given consignment code

GET /consignments/{code}/entries

2.14.1. Parameters

Type Name Description Schema Default

Path

code
required

The consignment code

string

Query

currentPage
optional

Current page

integer (int32)

0

Query

fields
optional

Fields mapping level

string

"DEFAULT"

Query

pageSize
optional

Page size

integer (int32)

10

Query

sort
optional

Sort parameter

string

"asc"

2.14.2. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.14.3. Produces

  • */*

2.14.4. Tags

  • warehousing-consignments-controller

2.15. Request to ge the Export Form for a given Consignment

GET /consignments/{code}/export-form

2.15.1. Parameters

Type Name Description Schema

Path

code
required

Code corresponding to the desired consignment

string

2.15.2. Responses

HTTP Code Description Schema

200

OK

string

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.15.3. Produces

  • */*

2.15.4. Tags

  • warehousing-consignments-controller

2.16. Checks if a consignment can be confirmed

GET /consignments/{code}/is-confirmable

2.16.1. Parameters

Type Name Description Schema

Path

code
required

The consignment code

string

2.16.2. Responses

HTTP Code Description Schema

200

OK

boolean

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.16.3. Produces

  • */*

2.16.4. Tags

  • warehousing-consignments-controller

2.17. Moves a consignment out of the waiting step after the payment capture has failed.

POST /consignments/{code}/manual/capture-payment

2.17.1. Parameters

Type Name Description Schema

Path

code
required

Code corresponding to the desired consignment

string

2.17.2. Responses

HTTP Code Description Schema

200

OK

string

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

  • warehousing-consignments-controller

2.18. Moves a consignment out of the waiting step after a tax commit has failed

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

2.18.1. Parameters

Type Name Description Schema

Path

code
optional

Code corresponding to the desired consignment

string

2.18.2. Responses

HTTP Code Description Schema

200

OK

string

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

  • warehousing-consignments-controller

2.19. Request to pack a given Consignment and optionally generate its Pack Label

POST /consignments/{code}/pack

2.19.1. Parameters

Type Name Description Schema Default

Path

code
required

Code corresponding to the desired consignment

string

Query

printSlip
optional

Flag for backwards compatibility. Used to check if the pack label will be generated

boolean

"true"

2.19.2. Responses

HTTP Code Description Schema

200

OK

string

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.19.3. Consumes

  • application/json

2.19.4. Produces

  • */*

2.19.5. Tags

  • warehousing-consignments-controller

2.20. Finds the packaging information for the given consignment code

GET /consignments/{code}/packaging-info

2.20.1. Parameters

Type Name Description Schema

Path

code
required

The consignment code

string

2.20.2. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.20.3. Produces

  • */*

2.20.4. Tags

  • warehousing-consignments-controller

2.21. Updates a consignment’s packaging information

PUT /consignments/{code}/packaging-info

2.21.1. Parameters

Type Name Description Schema Default

Path

code
required

The consignment code

string

Query

fields
optional

Fields mapping level

string

"DEFAULT"

Body

packagingInfo
required

The PackagingInfoWsDTO to update the consignment with

2.21.2. Responses

HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.21.3. Consumes

  • application/xml

  • application/json

2.21.4. Produces

  • application/xml

  • application/json

2.21.5. Tags

  • warehousing-consignments-controller

2.22. Request to pick a given Consignment and optionally generate its Pick Slip

POST /consignments/{code}/pick

2.22.1. Parameters

Type Name Description Schema Default

Path

code
required

Code corresponding to the desired consignment

string

Query

printSlip
optional

Flag for backwards compatibility. Used to check if the pick slip will be generated

boolean

"true"

2.22.2. Responses

HTTP Code Description Schema

200

OK

string

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.22.3. Consumes

  • application/json

2.22.4. Produces

  • */*

2.22.5. Tags

  • warehousing-consignments-controller

2.23. Reallocates a given consignment

POST /consignments/{code}/reallocate

2.23.1. Parameters

Type Name Description Schema

Path

code
required

The consignment code

string

Body

consignmentReallocationWsDTO
required

The ConsignmentReallocationWsDTO containing entries to be reallocated

2.23.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.23.3. Consumes

  • application/xml

  • application/json

2.23.4. Produces

  • application/xml

  • application/json

2.23.5. Tags

  • warehousing-consignments-controller

2.24. Request to get the Return form for a given Consignment

GET /consignments/{code}/return-form

2.24.1. Parameters

Type Name Description Schema

Path

code
required

Code corresponding to the desired consignment

string

2.24.2. Responses

HTTP Code Description Schema

200

OK

string

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.24.3. Produces

  • */*

2.24.4. Tags

  • warehousing-consignments-controller

2.25. Request to get the Return Shipping Label for a given Consignment

GET /consignments/{code}/return-shipping-label

2.25.1. Parameters

Type Name Description Schema

Path

code
required

Code corresponding to the desired consignment

string

2.25.2. Responses

HTTP Code Description Schema

200

OK

string

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.25.3. Produces

  • */*

2.25.4. Tags

  • warehousing-consignments-controller

2.26. Request to get the Shipping Label for a given Consignment

GET /consignments/{code}/shipping-label

2.26.1. Parameters

Type Name Description Schema

Path

code
required

Code corresponding to the desired consignment

string

2.26.2. Responses

HTTP Code Description Schema

200

OK

string

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.26.3. Produces

  • */*

2.26.4. Tags

  • warehousing-consignments-controller

2.27. Finds a paginated list of sourcing locations for a given consignment code

GET /consignments/{code}/sourcing-locations

2.27.1. Parameters

Type Name Description Schema Default

Path

code
required

The consignment code

string

Query

currentPage
optional

Current page

integer (int32)

0

Query

fields
optional

Fields mapping level

string

"DEFAULT"

Query

pageSize
optional

Page size

integer (int32)

10

Query

sort
optional

Sort parameter

string

"asc"

2.27.2. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.27.3. Produces

  • */*

2.27.4. Tags

  • warehousing-consignments-controller

2.28. Request to take a payment for a given Consignment

POST /consignments/{code}/take-payment

2.28.1. Parameters

Type Name Description Schema Default

Path

code
required

Code corresponding to the desired consignment

string

Query

fields
optional

Fields mapping level

string

"DEFAULT"

2.28.2. Responses

HTTP Code Description Schema

200

OK

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

  • warehousing-consignments-controller

2.29. Puts an order on hold

POST /orders/{code}/on-hold

2.29.1. Parameters

Type Name Description Schema

Path

code
required

Order 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/xml

  • application/json

2.29.4. Produces

  • application/xml

  • application/json

2.29.5. Tags

  • warehousing-orders-controller

2.30. Resources an order

POST /orders/{code}/re-source

2.30.1. Parameters

Type Name Description Schema

Path

code
required

Order code

string

2.30.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.30.3. Consumes

  • application/xml

  • application/json

2.30.4. Produces

  • application/xml

  • application/json

2.30.5. Tags

  • warehousing-orders-controller

2.31. Finds one point of service by name

GET /pointofservices/{name}

2.31.1. Parameters

Type Name Description Schema Default

Path

name
required

The name of the point of service to be fetched

string

Query

fields
optional

Fields mapping level

string

"DEFAULT"

2.31.2. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.31.3. Produces

  • */*

2.31.4. Tags

  • warehousing-point-of-services-controller

2.32. Updates point of service with an address

PUT /pointofservices/{pointOfServiceName}/address

2.32.1. Parameters

Type Name Description Schema Default

Path

pointOfServiceName
required

The name of the point of service

string

Query

fields
optional

Fields mapping level

string

"DEFAULT"

Body

address
required

The AddressWsDTO object to update the point of service with

2.32.2. Responses

HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.32.3. Consumes

  • application/xml

  • application/json

2.32.4. Produces

  • application/xml

  • application/json

2.32.5. Tags

  • warehousing-point-of-services-controller

2.33. Updates a point of service with a list of warehouse codes

POST /pointofservices/{pointOfServiceName}/warehouses

2.33.1. Description

It takes one or more valid warehouse code to update the given point of service with

2.33.2. Parameters

Type Name Description Schema Default

Path

pointOfServiceName
required

The name of the point of service

string

Query

fields
optional

Fields mapping level

string

"DEFAULT"

Body

warehouseCodes
required

The WarehouseCodesWsDto that contains a list of valid warehouse codes

2.33.3. Responses

HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.33.4. Consumes

  • application/xml

  • application/json

2.33.5. Produces

  • application/xml

  • application/json

2.33.6. Tags

  • warehousing-point-of-services-controller

2.34. Finds a paginated list of warehouses per given point of service

GET /pointofservices/{pointOfServiceName}/warehouses

2.34.1. Parameters

Type Name Description Schema Default

Path

pointOfServiceName
required

The name of the point of service

string

Query

currentPage
optional

Current page

integer (int32)

0

Query

fields
optional

Fields mapping level

string

"DEFAULT"

Query

pageSize
optional

Page size

integer (int32)

10

Query

sort
optional

Sort parameter

string

"asc"

2.34.2. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.34.3. Produces

  • */*

2.34.4. Tags

  • warehousing-point-of-services-controller

2.35. Request to delete a warehouse from point of service

DELETE /pointofservices/{pointOfServiceName}/warehouses/{warehouseCode}

2.35.1. Parameters

Type Name Description Schema Default

Path

pointOfServiceName
required

The name of the point of service

string

Path

warehouseCode
required

The code of the warehouse to be deleted from the point of service

string

Query

fields
optional

Fields mapping level

string

"DEFAULT"

2.35.2. Responses

HTTP Code Description Schema

204

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.35.3. Produces

  • application/xml

  • application/json

2.35.4. Tags

  • warehousing-point-of-services-controller

2.36. Request to accept returned goods

POST /returns/{code}/accept-goods

2.36.1. Parameters

Type Name Description Schema

Path

code
required

Return code to be accepted

string

2.36.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.36.3. Consumes

  • application/json

2.36.4. Produces

  • */*

2.36.5. Tags

  • warehousing-returns-controller

2.37. Creates a stocklevel

POST /stocklevels

2.37.1. Parameters

Type Name Description Schema Default

Query

fields
optional

Fields mapping level

string

"DEFAULT"

Body

stockLevelWsDto
required

The stocklevel object to be created

2.37.2. Responses

HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.37.3. Consumes

  • application/xml

  • application/json

2.37.4. Produces

  • application/xml

  • application/json

2.37.5. Tags

  • warehousing-stock-levels-controller

2.38. Finds all adjustment reasons

GET /stocklevels/adjustment-reasons

2.38.1. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.38.2. Produces

  • */*

2.38.3. Tags

  • warehousing-stock-levels-controller

2.39. Creates an inventoryEvent to adjust a specific stocklevel

POST /stocklevels/product/{productCode}/warehouse/{warehouseCode}/adjustment

2.39.1. Parameters

Type Name Description Schema

Path

productCode
required

Product Code

string

Path

warehouseCode
required

Warehouse Code

string

Query

binCode
optional

Bin Code

string

Query

releaseDate
optional

Release Date

string

Body

stockLevelAdjustmentsWsDTO
required

List of stockLevel Adjustments

2.39.2. Responses

HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.39.3. Consumes

  • application/xml

  • application/json

2.39.4. Produces

  • application/xml

  • application/json

2.39.5. Tags

  • warehousing-stock-levels-controller

2.40. Finds a paginated list of stock levels by a given warehouse code

GET /stocklevels/warehouses/{code}

2.40.1. Parameters

Type Name Description Schema Default

Path

code
required

The code for the warehouse

string

Query

currentPage
optional

Current page

integer (int32)

0

Query

fields
optional

Fields mapping level

string

"DEFAULT"

Query

pageSize
optional

Page size

integer (int32)

10

Query

sort
optional

Sort parameter

string

"asc"

2.40.2. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.40.3. Produces

  • */*

2.40.4. Tags

  • warehousing-stock-levels-controller

2.41. Finds a warehouse by the given code

GET /warehouses/{code}

2.41.1. Description

It returns a warehouse for the given code, the given warehouse code should be valid

2.41.2. Parameters

Type Name Description Schema Default

Path

code
required

code

string

Query

fields
optional

The code of the requested warehouse

string

"DEFAULT"

2.41.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.41.4. Produces

  • */*

2.41.5. Tags

  • warehousing-warehouses-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

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

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. AsnEntryWsDTO

Name Schema

productCode
optional

string

quantity
optional

integer (int32)

3.3. AsnWsDTO

Name Schema

asnEntries
optional

< AsnEntryWsDTO > array

comment
optional

string

externalId
optional

string

internalId
optional

string

pointOfServiceName
optional

string

releaseDate
optional

string (date-time)

status
optional

string

warehouseCode
optional

string

3.4. BaseOption

Representation of a Base Ooption

Name Description Schema

options
optional

List of all variant options

< VariantOption > array

selected
optional

Variant option selected

variantType
optional

Variant type of base option

string

3.5. Category

Representation of a Category

Name Description Schema

code
optional

Code of the category

string

image
optional

Category image

name
optional

Name of the category

string

url
optional

URL of the category

string

3.6. 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.7. 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.8. Consignment

Representation of a Consignment

Name Description Schema

code
optional

Consignment code

string

deliveryMode
optional

deliveryPointOfService
optional

Delivery point of service

entries
optional

List of consignment entries

< ConsignmentEntry > array

orderCode
optional

string

packagingInfo
optional

shippingAddress
optional

Shipping 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.9. ConsignmentCodesWsDTO

Name Schema

codes
optional

< string > array

3.10. ConsignmentEntry

Representation of a Consignment Entry

Name Description Schema

orderEntry
optional

Order entry of Consignment entry

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.11. ConsignmentEntrySearchPageWsDto

Name Schema

consignmentEntries
optional

< ConsignmentEntry > array

pagination
optional

sorts
optional

< Sort > array

3.12. ConsignmentReallocationWsDTO

Name Schema

declineEntries
optional

< DeclineEntryWsDTO > array

globalComment
optional

string

globalReallocationWarehouseCode
optional

string

globalReason
optional

string

3.13. ConsignmentSearchPageWsDto

Name Schema

consignments
optional

< Consignment > array

pagination
optional

sorts
optional

< Sort > array

3.14. ConsignmentStatusListWsDTO

Name Schema

statuses
optional

< string > array

3.15. 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.16. 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.17. DeclineEntryWsDTO

Name Schema

comment
optional

string

productCode
optional

string

quantity
optional

integer (int64)

reallocationWarehouseCode
optional

string

reason
optional

string

3.18. DeclineReasonListWsDTO

Name Schema

reasons
optional

< string > array

3.19. DeliveryMode

Representation of a Delivery mode

Name Description Schema

code
optional

Code of the delivery mode

string

deliveryCost
optional

Cost of the delivery

description
optional

Description of the delivery mode

string

name
optional

Name of the delivery mode

string

3.20. 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

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.21. 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.22. FeatureValue

Representation of a Feature Value

Name Description Schema

value
optional

Value of the feature

string

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

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. OrderEntry

Representation of an Order entry

Name Description Schema

basePrice
optional

Base price of order entry item

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

configurationInfos
optional

Configuration info of order entry

< ConfigurationInfo > array

deliveryMode
optional

Delivery mode

deliveryPointOfService
optional

Point of service associated with order entry

entryNumber
optional

Entry number of the order entry

integer (int32)

product
optional

Product details of order entry

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

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

updateable
optional

Flag defining if order entry item is updateable

boolean

url
optional

string

3.29. 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.30. 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.31. PointOfService

Representation of a Point of service

Name Description Schema

address
optional

Address information of point of service

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

mapIcon
optional

Image associated with the point of service

name
optional

Name of the point of service

string

openingHours
optional

Opening hours of point of service

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.32. PointOfServiceSearchPageWsDTO

Name Schema

pagination
optional

pointsOfService
optional

< PointOfService > array

sorts
optional

< Sort > array

3.33. 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.34. PriceRange

Representation of a Price Range

Name Description Schema

maxPrice
optional

Maximum value of the Price Range

minPrice
optional

Minium value of the Price Range

3.35. 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

priceRange
optional

Price range assigned to the product

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

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

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.36. 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

3.37. 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

promotionGroup
optional

Group of the promotion

string

promotionType
optional

Type of the promotion

string

restrictions
optional

List of promotion restrictions

startDate
optional

The initial date of the promotion

string (date-time)

title
optional

Promotion title

string

3.38. 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.39. 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.40. 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

rating
optional

Review rating value

number (double)

3.41. 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.42. 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

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

3.43. 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.44. 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.45. StockLevelAdjustmentReasonsWsDTO

Name Schema

reasons
optional

< string > array

3.46. StockLevelAdjustmentWsDTO

Name Schema

comment
optional

string

quantity
optional

integer (int64)

reason
optional

string

3.47. StockLevelAdjustmentsWsDTO

Name Schema

stockLevelAdjustments
optional

3.48. StockLevelSearchPageWsDto

Name Schema

pagination
optional

sorts
optional

< Sort > array

stockLevels
optional

< StockLevelWsDto > array

3.49. StockLevelWsDto

Name Schema

bin
optional

string

inStockStatus
optional

string

initialQuantityOnHand
optional

integer (int32)

productCode
optional

string

releaseDate
optional

string (date-time)

warehouse
optional

3.50. 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.51. User

Representation of an User

Name Description Schema

currency
optional

User preferred currency

customerId
optional

Customer identifier

string

deactivationDate
optional

Deactivation date

string (date-time)

defaultAddress
optional

User address

displayUid
optional

User identifier

string

firstName
optional

User first name

string

language
optional

User preferred 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.52. 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.53. VariantMatrixElement

Representation of a Variant Matrix Element

Name Description Schema

elements
optional

List of elements with the type of variant matrix element

isLeaf
optional

boolean

parentVariantCategory
optional

Parent variant category for variant matrix element

variantOption
optional

Variant option for variant matrix element

variantValueCategory
optional

Variant value category for variant matrix element

3.54. 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

stock
optional

Stock value of the variant option

url
optional

Url address of the variant option

string

variantOptionQualifiers
optional

List of variant option qualifiers

3.55. VariantOptionQualifier

Representation of a Variant Option Qualifier

Name Description Schema

image
optional

Image associated with variant option qualifier

name
optional

Name of variant option qualifier

string

qualifier
optional

Qualifier

string

value
optional

Value of variant option qualifier

string

3.56. 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.57. WarehouseCodesWsDto

Name Schema

codes
optional

< string > array

3.58. WarehouseSearchPageWsDto

Name Schema

pagination
optional

sorts
optional

< Sort > array

warehouses
optional

< WarehouseWsDto > array

3.59. WarehouseWsDto

Name Schema

code
optional

string

consignments
optional

< Consignment > array

deliveryModes
optional

< DeliveryMode > array

isDefault
optional

boolean

pointsOfServices
optional

< PointOfService > array

priority
optional

integer (int32)

url
optional

string

3.60. 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

openingTime
optional

Starting time of opening day

weekDay
optional

Text representation of week day opening day

string

3.61. 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)