IOM Communication REST API (2.11)

Download OpenAPI specification:Download

The IOM Communication REST API supports dispatch, order response and return message transmission to the IOM.

Authentication

basicAuth

Basic Authentication

Security Scheme Type	HTTP
HTTP Authorization Scheme	basic

bearerAuth

JWT Bearer token

Security Scheme Type	HTTP
HTTP Authorization Scheme	bearer
Bearer format	"JWT"

Dispatch

Create a order dispatch message

Persist a dispatch message and triggers the processing

Authorizations:

basicAuthbearerAuth

Request Body schema: application/vnd.intershop.dispatch-message.v1+json

messageId required	string The unique message Id.
supplierName required	string The name of the supplier.
supplierShopName required	string The name of the shop as used by the supplier.
shopOrderNumber required	string [ 1 .. 50 ] characters The order number as used by the shop.
supplierOrderNumber	string [ 0 .. 250 ] characters The order number as used by the supplier.
dispatchDate required	string <date-time> Date of the hand over of the package to the carrier. Note: Must conform to the ISO 8601 format.
deliveryNoteNumber	string [ 0 .. 70 ] characters The delivery note number.
carrier required	object (Carrier) Information about the carrier and the shipment.
positions required	Array of objects (DispatchPosition) [ 1 .. 2147483647 ] items List of dispatch positions. Note: The attribute `orderPositionNumber` must be unique per dispatch message.
propertyGroups	Array of objects (PropertyGroup) Properties of the dispatch, grouped by a name.

Responses

201

Created

400

Bad Request

401

Authentication information is missing or invalid.

403

Forbidden

415

Unsupported Media Type

500

An unexpected error occured.

post /dispatches

{protocol}://{domain}:{port}/rest/communication/dispatches

Request samples

Payload

Content type

application/vnd.intershop.dispatch-message.v1+json

Copy

Expand all Collapse all


{"messageId": "906090-42",
"supplierName": "Demo-Supplier",
"supplierShopName": "Demo-Shop",
"shopOrderNumber": "78231.2018",
"supplierOrderNumber": "398-8923#556",
"dispatchDate": "2018-05-10T14:52:26.467Z",
"deliveryNoteNumber": "DE-3290-030-9023",
"carrier": 
{"name": "DHL",
"packages": 1,
"trackingNumber": "A1S044987623"
},
"positions": 
[
{"orderPositionNumber": 1,
"dispatchedQuantity": 1,
"product": 
{"name": "Demo-Product",
"number": "47119910",
"shopProductNumber": "so-7119910",
"supplierProductNumber": "su-47119910"
},
"items": 
[
{"serialNumber": "667002",
"propertyGroups": 
[
{"name": "DEMO-Group",
"properties": 
[
{"key": "key",
"value": "value"
}
]
}
]
}
],
"propertyGroups": 
[
{"name": "DEMO-Group",
"properties": 
[
{"key": "key",
"value": "value"
}
]
}
]
}
],
"propertyGroups": 
[
{"name": "DEMO-Group",
"properties": 
[
{"key": "key",
"value": "value"
}
]
}
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"status": 400,
"errors": 
[
{"code": "VALIDATION_EXCEPTION",
"message": "Attribute XYZ is mandatory",
"value": { }
}
]
}

Response

Create a order response message

Persist a order response message and triggers the processing

Authorizations:

basicAuthbearerAuth

Request Body schema: application/vnd.intershop.response-message.v1+json

messageId required	string The unique message Id.
supplierName required	string The name of the supplier.
supplierShopName required	string The name of the shop as used by the supplier.
shopOrderNumber required	string [ 1 .. 50 ] characters The order number as used by the shop.
supplierOrderNumber	string [ 0 .. 250 ] characters The order number as used by the supplier.
entryDate	string <date-time> Timestamp when the supplier has created the response. Note: Must conform to the ISO 8601 format.
supplierStateCode required	string [ 1 .. 50 ] characters Status code of the response. Note: Must refer to an entry of the "SupplierResponseStateCodeDefDO" configuration or one of the IOM internal response state codes.
positions required	Array of objects (OrderResponsePosition) [ 1 .. 2147483647 ] items List of order response positions. Note: The attribute `orderPositionNumber` must be unique per response message.
propertyGroups	Array of objects (PropertyGroup) Properties of the order response, grouped by a name.

Responses

201

Created

400

Bad Request

401

Authentication information is missing or invalid.

403

Forbidden

415

Unsupported Media Type

500

An unexpected error occured.

post /responses

{protocol}://{domain}:{port}/rest/communication/responses

Request samples

Payload

Content type

application/vnd.intershop.response-message.v1+json

Copy

Expand all Collapse all


{"messageId": "906090-42",
"supplierName": "Demo-Supplier",
"supplierShopName": "Demo-Shop",
"shopOrderNumber": "78231.2018",
"supplierOrderNumber": "398-8923#556",
"entryDate": "2018-12-09T15:32:32.123Z",
"supplierStateCode": "string",
"positions": 
[
{"orderPositionNumber": 1,
"product": 
{"name": "Demo-Product",
"number": "47119910",
"shopProductNumber": "so-7119910",
"supplierProductNumber": "su-47119910"
},
"quantityCanceled": 0,
"confirmedDelivery": 
{"quantity": 1,
"plannedDeliveryDate": "2020-01-20T00:00:00.000Z"
},
"backorderedDelivery": 
{"quantity": 1,
"plannedDeliveryDate": "2020-01-31T00:00:00.000Z"
},
"netPurchasePrice": 
{"amount": 6.43,
"currency": "EUR"
},
"propertyGroups": 
[
{"name": "DEMO-Group",
"properties": 
[
{"key": "key",
"value": "value"
}
]
}
]
}
],
"propertyGroups": 
[
{"name": "DEMO-Group",
"properties": 
[
{"key": "key",
"value": "value"
}
]
}
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"status": 400,
"errors": 
[
{"code": "VALIDATION_EXCEPTION",
"message": "Attribute XYZ is mandatory",
"value": { }
}
]
}

Return

Create a order return message

Persist a return message and triggers the processing

Authorizations:

basicAuthbearerAuth

Request Body schema: application/vnd.intershop.return-message.v1+json

messageId required	string The unique message Id.
supplierName required	string The name of the supplier.
supplierShopName required	string The name of the shop as used by the supplier.
shopOrderNumber required	string [ 1 .. 50 ] characters The order number as used by the shop.
supplierOrderNumber	string [ 0 .. 250 ] characters The order number as used by the supplier.
reason required	string Reason of return. Note: Must refer to an entry of the "Supplier2ReturnReasonDefDO" configuration or one of the IOM internal return reasons.
entryDate required	string <date-time> Date of entrance of the return at the supplier. Note: Must conform to the ISO 8601 format.
positions required	Array of objects (ReturnPosition) [ 1 .. 2147483647 ] items List of return positions. Note: The attribute `orderPositionNumber` must be unique per return message.
propertyGroups	Array of objects (PropertyGroup) Properties of the return, grouped by a name.

Responses

201

Created

400

Bad Request

401

Authentication information is missing or invalid.

403

Forbidden

415

Unsupported Media Type

500

An unexpected error occured.

post /returns

{protocol}://{domain}:{port}/rest/communication/returns

Request samples

Payload

Content type

application/vnd.intershop.return-message.v1+json

Copy

Expand all Collapse all


{"messageId": "906090-42",
"supplierName": "Demo-Supplier",
"supplierShopName": "Demo-Shop",
"shopOrderNumber": "78231.2018",
"supplierOrderNumber": "398-8923#556",
"reason": "RET010",
"entryDate": "2018-09-14T14:22:32.123Z",
"positions": 
[
{"orderPositionNumber": 1,
"returnedQuantity": 1,
"product": 
{"name": "Demo-Product",
"number": "47119910",
"shopProductNumber": "so-7119910",
"supplierProductNumber": "su-47119910"
},
"items": 
[
{"serialNumber": "109312",
"propertyGroups": 
[
{"name": "DEMO-Group",
"properties": 
[
{"key": "key",
"value": "value"
}
]
}
]
}
],
"propertyGroups": 
[
{"name": "DEMO-Group",
"properties": 
[
{"key": "key",
"value": "value"
}
]
}
]
}
],
"propertyGroups": 
[
{"name": "DEMO-Group",
"properties": 
[
{"key": "key",
"value": "value"
}
]
}
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"status": 400,
"errors": 
[
{"code": "VALIDATION_EXCEPTION",
"message": "Attribute XYZ is mandatory",
"value": { }
}
]
}