This API specification is available for download as an Open API 2.0 YAML file:
API endpoints, that could be used by the shop.
/shops/{shopName}/orders/{shopOrderNumber}/return-requests
Returns a list of return requests for a given shopName and shopOrderNumber.
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | shopOrderNumber | string | Required | The order number of the shop | ||
in path | shopName | string | Required | The shop name |
200 - OK
401 - Unauthorized Authentication information is missing or invalid
Response Header | Description |
---|---|
WWW-Authenticate |
403 - Forbidden
404 - Not Found
406 - Not Acceptable
Creates a new return request
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | shopOrderNumber | string | Required | The order number of the shop | ||
in path | shopName | string | Required | The shop name |
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
Response Header | Description |
---|---|
WWW-Authenticate |
403 - Forbidden
415 - Unsupported Media Type
500 - Internal Server Error An unexpected error occured
/shops/{shopName}/orders/{shopOrderNumber}/return-requests/{returnRequestId}
Returns a return request for a given shopName, shopOrderNumber and returnRequestId.
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | returnRequestId | integer int64 | Required | The return request id of the related order | ||
in path | shopOrderNumber | string | Required | The order number of the shop | ||
in path | shopName | string | Required | The shop name |
200 - OK
401 - Unauthorized Authentication information is missing or invalid
Response Header | Description |
---|---|
WWW-Authenticate |
403 - Forbidden
404 - Not Found
406 - Not Acceptable
/shops/{shopName}/orders/{shopOrderNumber}/return-requests/{returnRequestId}/contact-persons
Returns a list of return request contact persons for a given returnRequestId, shopName and shopOrderNumber.
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | returnRequestId | integer int64 | Required | The return request id of the related order | ||
in path | shopOrderNumber | string | Required | The order number of the shop | ||
in path | shopName | string | Required | The shop name |
200 - OK
401 - Unauthorized Authentication information is missing or invalid
Response Header | Description |
---|---|
WWW-Authenticate |
403 - Forbidden
404 - Not Found
406 - Not Acceptable
/shops/{shopName}/orders/{shopOrderNumber}/return-requests/{returnRequestId}/custom-attributes
Returns a list of return request custom attributes for a given returnRequestId, shopName and shopOrderNumber.
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | returnRequestId | integer int64 | Required | The return request id of the related order | ||
in path | shopOrderNumber | string | Required | The order number of the shop | ||
in path | shopName | string | Required | The shop name |
200 - OK
401 - Unauthorized Authentication information is missing or invalid
Response Header | Description |
---|---|
WWW-Authenticate |
403 - Forbidden
404 - Not Found
406 - Not Acceptable
/shops/{shopName}/orders/{shopOrderNumber}/return-requests/{returnRequestId}/pickup-addresses
Returns a list of return request pickup addresses for a given returnRequestId, shopName and shopOrderNumber.
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | returnRequestId | integer int64 | Required | The return request id of the related order | ||
in path | shopOrderNumber | string | Required | The order number of the shop | ||
in path | shopName | string | Required | The shop name |
200 - OK
401 - Unauthorized Authentication information is missing or invalid
Response Header | Description |
---|---|
WWW-Authenticate |
403 - Forbidden
404 - Not Found
406 - Not Acceptable
/shops/{shopName}/orders/{shopOrderNumber}/return-requests/{returnRequestId}/positions
Returns a list of return request positions for a given returnRequestId, shopName and shopOrderNumber.
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | returnRequestId | integer int64 | Required | The return request id of the related order | ||
in path | shopOrderNumber | string | Required | The order number of the shop | ||
in path | shopName | string | Required | The shop name |
200 - OK
401 - Unauthorized Authentication information is missing or invalid
Response Header | Description |
---|---|
WWW-Authenticate |
403 - Forbidden
404 - Not Found
406 - Not Acceptable
/shops/{shopName}/orders/{shopOrderNumber}/return-requests/{returnRequestId}/positions/{returnRequestPositionId}
Returns a return request position for a given returnRequestId, shopName, shopOrderNumber and a returnRequestPositionId.
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | returnRequestPositionId | integer int64 | Required | The return request position id of the related return request | ||
in path | returnRequestId | integer int64 | Required | The return request id of the related order | ||
in path | shopOrderNumber | string | Required | The order number of the shop | ||
in path | shopName | string | Required | The shop name |
200 - OK
401 - Unauthorized Authentication information is missing or invalid
Response Header | Description |
---|---|
WWW-Authenticate |
403 - Forbidden
404 - Not Found
406 - Not Acceptable
/shops/{shopName}/orders/{shopOrderNumber}/return-requests/{returnRequestId}/positions/{returnRequestPositionId}/items
Returns a list of return request position items for a given returnRequestId, shopName and shopOrderNumber.
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | returnRequestPositionId | integer int64 | Required | The return request position id of the related return request | ||
in path | returnRequestId | integer int64 | Required | The return request id of the related order | ||
in path | shopOrderNumber | string | Required | The order number of the shop | ||
in path | shopName | string | Required | The shop name |
200 - OK
401 - Unauthorized Authentication information is missing or invalid
Response Header | Description |
---|---|
WWW-Authenticate |
403 - Forbidden
404 - Not Found
406 - Not Acceptable
ContactPerson
: Represents a contact person of the return request from an order of a shop.Link
objects.Link
int64
| Example: 10000
Intershop Communication AG
John
Doe
0176 12345677
john.doe@intershop.com
english
int32
| Example: 400
Error
objects.Error
VALIDATION_EXCEPTION
Attribute XYZ is mandatory
1
| Max Length: 250
| Example: Example Key
1
| Max Length: 1000
| Example: Example Value
Link
objects.Link
int64
| Example: 10000
1
| Max Length: 100
| Example: Intershop Communication AG
1
| Max Length: 50
| Example: John
1
| Max Length: 50
| Example: Doe
1
| Max Length: 100
| Example: Alexstraße
1
| Max Length: 20
| Example: 28
1
| Max Length: 25
| Example: 12053
1
| Max Length: 100
| Example: Berlin
DEU
1
| Max Length: 100
| Example: Berlin
1
| Max Length: 100
| Example: Finanz
1
| Max Length: 100
| Example: 3.Floor
Link
objects.Link
int64
| Example: 10000
RETURN
| Possible Values: RETURN
PICKUP
1
| Max Length: 50
| Example: 10901095
0
| Max Length: 255
| Example: The battery is draining quickly
Link
objects.Link
int64
| Example: 10000
date-time
| Example: 2018-02-27T09:15:37.562+02:00
20180303_123
Test Shop US DE
20180303_321
Test Supplier US DE
accepted
1
| Max Length: 70
| Example: W88401231AX
Link
objects.Link
int64
| Example: 10000
int32
| Example: 1
1
| Max Length: 50
| Example: 20180303_123
RET100
int32
| Example: 1
Link
objects.Link
int64
| Example: 10000
test_product_1
20180303_123
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.