This API specification is available for download as an Open API 3.0 YAML file:
Please configure your clients to use this authentication method to submit user name and password.
To generate a valid JWT, just log into the OMT, inspect the browser cookies and use the value of the cookie called 'OMS_IDENTITY' as JWT. Within a UI-client (e.g., Postman) choose "Bearer Token" and just type in a valid Json Web Token (JWT).
The permission "Create delivery message" is required and must be assigned to the supplier and shop mentioned in the payload.
/dispatches
Persist a dispatch message and triggers the processing
201 - Created
Response Header | Description |
---|---|
Location | The path to the newly created resource. | Format: url |
400 - Bad Request
401 - Unauthorized Authentication information is missing or invalid.
403 - Forbidden
415 - Unsupported Media Type
500 - Internal Server Error An unexpected error occured.
/responses
Persist a order response message and triggers the processing
201 - Created
Response Header | Description |
---|---|
Location | The path to the newly created resource. | Format: url |
400 - Bad Request
401 - Unauthorized Authentication information is missing or invalid.
403 - Forbidden
415 - Unsupported Media Type
500 - Internal Server Error An unexpected error occured.
/returns
Persist a return message and triggers the processing
201 - Created
Response Header | Description |
---|---|
Location | The path to the newly created resource. | Format: url |
400 - Bad Request
401 - Unauthorized Authentication information is missing or invalid.
403 - Forbidden
415 - Unsupported Media Type
500 - Internal Server Error An unexpected error occured.
906090-42
Demo-Supplier
Demo-Shop
1
| Max Length: 50
| Example: 78231.2018
0
| Max Length: 250
| Example: 398-8923#556
date-time
| Example: 2018-05-10T14:52:26.467Z
0
| Max Length: 70
| Example: DE-3290-030-9023
Carrier
object. Information about the carrier and the shipment.DHL
int32
| Example: 1
A1S044987623
DispatchPosition
objects. List of dispatch positions. Note: The attribute orderPositionNumber
must be unique per dispatch message.DispatchPosition
: List of dispatch positions. Note: The attribute `orderPositionNumber` must be unique per dispatch message.int32
| Example: 1
int32
| Example: 1
Product
object. The product to return.Demo-Product
@Deprecated and will be removed mit next major version. You may additionally set shopProductNumber or supplierProductNumber which will be used privileged!
- The product number as used by the supplier or shop. Note: It's used to determine the corresponding order position. | Min Length: 1
| Max Length: 2147483647
| Example: 47119910
so-7119910
su-47119910
DispatchItem
objects. There are further information for each single product. Note: The number of items will be count as dispatched quantity.DispatchItem
: There are further information for each single product. Note: The number of items will be count as dispatched quantity.667002
PropertyGroup
objects. Properties of the dispatch item, grouped by a name.PropertyGroup
: Properties of the return, grouped by a name.1
| Max Length: 250
| Example: DEMO-Group
Property
objects. The list of properties.Property
: The list of properties.1
| Max Length: 250
| Example: key
1
| Max Length: 1000
| Example: value
PropertyGroup
objects. Properties of the order response position, grouped by a name.PropertyGroup
: Properties of the return, grouped by a name.1
| Max Length: 250
| Example: DEMO-Group
Property
objects. The list of properties.Property
: The list of properties.1
| Max Length: 250
| Example: key
1
| Max Length: 1000
| Example: value
PropertyGroup
objects. Properties of the dispatch, grouped by a name.PropertyGroup
: Properties of the return, grouped by a name.1
| Max Length: 250
| Example: DEMO-Group
Property
objects. The list of properties.Property
: The list of properties.1
| Max Length: 250
| Example: key
1
| Max Length: 1000
| Example: value
int32
| Example: 400
Error
objects.Error
VALIDATION_EXCEPTION
Attribute XYZ is mandatory
906090-42
Demo-Supplier
Demo-Shop
1
| Max Length: 50
| Example: 78231.2018
0
| Max Length: 250
| Example: 398-8923#556
date-time
| Example: 2018-12-09T15:32:32.123Z
1
| Max Length: 50
OrderResponsePosition
objects. List of order response positions. Note: The attribute orderPositionNumber
must be unique per response message.OrderResponsePosition
: List of order response positions. Note: The attribute `orderPositionNumber` must be unique per response message.int32
| Example: 1
Product
object. The product to return.Demo-Product
@Deprecated and will be removed mit next major version. You may additionally set shopProductNumber or supplierProductNumber which will be used privileged!
- The product number as used by the supplier or shop. Note: It's used to determine the corresponding order position. | Min Length: 1
| Max Length: 2147483647
| Example: 47119910
so-7119910
su-47119910
int32
| Example: 0
ConfirmedDelivery
object. Confirmed delivery object.int32
| Example: 1
date
| Example: 2020-01-20T00:00:00.000Z
BackorderedDelivery
object. Backordered delivery object.int32
| Example: 1
date
| Example: 2020-01-31T00:00:00.000Z
NetPurchasePrice
object. Net item purchase price object.double
| Example: 6.43
EUR
PropertyGroup
objects. Properties of the order response position, grouped by a name.PropertyGroup
: Properties of the return, grouped by a name.1
| Max Length: 250
| Example: DEMO-Group
Property
objects. The list of properties.Property
: The list of properties.1
| Max Length: 250
| Example: key
1
| Max Length: 1000
| Example: value
PropertyGroup
objects. Properties of the order response, grouped by a name.PropertyGroup
: Properties of the return, grouped by a name.1
| Max Length: 250
| Example: DEMO-Group
Property
objects. The list of properties.Property
: The list of properties.1
| Max Length: 250
| Example: key
1
| Max Length: 1000
| Example: value
906090-42
Demo-Supplier
Demo-Shop
1
| Max Length: 50
| Example: 78231.2018
0
| Max Length: 250
| Example: 398-8923#556
RET010
date-time
| Example: 2018-09-14T14:22:32.123Z
ReturnPosition
objects. List of return positions. Note: The attribute orderPositionNumber
must be unique per return message.ReturnPosition
: List of return positions. Note: The attribute `orderPositionNumber` must be unique per return message.int32
| Example: 1
int32
| Example: 1
Product
object. The product to return.Demo-Product
@Deprecated and will be removed mit next major version. You may additionally set shopProductNumber or supplierProductNumber which will be used privileged!
- The product number as used by the supplier or shop. Note: It's used to determine the corresponding order position. | Min Length: 1
| Max Length: 2147483647
| Example: 47119910
so-7119910
su-47119910
ReturnItem
objects. There are further information for each single article. Note that the number of articles will be the count of the listed products.ReturnItem
: There are further information for each single article. Note that the number of articles will be the count of the listed products.109312
PropertyGroup
objects. Properties of the return item, grouped by a name.PropertyGroup
: Properties of the return, grouped by a name.1
| Max Length: 250
| Example: DEMO-Group
Property
objects. The list of properties.Property
: The list of properties.1
| Max Length: 250
| Example: key
1
| Max Length: 1000
| Example: value
PropertyGroup
objects. Properties of the return position, grouped by a name.PropertyGroup
: Properties of the return, grouped by a name.1
| Max Length: 250
| Example: DEMO-Group
Property
objects. The list of properties.Property
: The list of properties.1
| Max Length: 250
| Example: key
1
| Max Length: 1000
| Example: value
PropertyGroup
objects. Properties of the return, grouped by a name.PropertyGroup
: Properties of the return, grouped by a name.1
| Max Length: 250
| Example: DEMO-Group
Property
objects. The list of properties.Property
: The list of properties.1
| Max Length: 250
| Example: key
1
| Max Length: 1000
| Example: value
The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.