Document Tree
Document Properties
Kbid
310F98
Last Modified
04-Jan-2024
Added to KB
15-Dec-2023
Public Access
Everyone
Status
Online
Doc Type
References
Product
  • ICM 11
  • IOM Connector
Home ⋮ Knowledge Base
Reference - Order IOM Extension REST API 1.0.1
Share this document
ReDoc View
Document View


The Order IOM Extension REST API works only with the IOM Connector enabled.

This API specification is available for download as an Open API 3.0 YAML file: 

References

The following page lists available REST APIs for ICM 11 and their version dependencies:

API Specification

Introduction
OpenAPI Version: 3.0.1
Order IOM Extension Version: 1.0.1

The Order IOM Extension REST API, provided by the IOM Connector, introduces IOM-specific resources
that extend the capabilities of the standard Order REST API.
To make use of these extensions, it is crucial to have the IOM Connector customization correctly installed and configured.

API Versioning & Accept-Header

Media type based versioning is used to distinguish between different API versions.
For requests to the Order IOM Extension REST API v1, the REST client must set the following HTTP Accept header:

Accept: application/vnd.intershop.order-iom-ext.v1+json

Order API resource objects extensions

If the IOM Connector is installed, it also extends the standard Order REST API with the following attributes:

IOMPaymentStatus in OrderRO:

The IOMPaymentStatus object represents the payment status of the order. It includes the following properties:

  • paidAmount: An object that represents the amount that has been paid for the order
    • currency (string): The currency of the paidAmount
    • value (number): The value of the paidAmount
  • paidAmountPercent (number): The percentage of the order amount that has been paid
  • paymentStatus (string): The status of the payment for the order (e.g., "Paid")
  • remainingAmount: An object that represents the remaining amount to be paid for the order
    • currency (string): The currency of the remainingAmount
    • value (number): The value of the remainingAmount
  • remainingAmountPercent (number): The percentage of the order amount that is remaining to be paid

Example:

"IOMPaymentStatus": {
    "paidAmount": {
        "currency": "USD",
        "value": 789.00
    },
    "paidAmountPercent": 100,
    "paymentStatus": "Paid",
    "remainingAmount": {
        "currency": "USD",
        "value": 0.00
    },
    "remainingAmountPercent": 0
}

IOMShippingStatus in OrderLineItemRO:

The IOMShippingStatus object represents the shipping status of the order line item. It includes the following properties:

  • name (string): The name of the shipping carrier
  • packages (integer($int32)): The number of packages associated with the shipping carrier
  • trackingNumbers (string[]): An array of tracking numbers associated with the shipping carrier

Example:

"IOMShippingStatus": [
    {
        "name": "STD_GROUND",
        "packages": 1,
        "trackingNumbers": [
            "4454545454242"
        ]
    }
]

Changelog

Version 1.0.1

  • added documentation about Order API resource objects extensions
  • adapt documentation for Key Features section
  • added status codes for Document requests

Version 1.0.0

Initial Release

Key Features:

  • Order-Related Documents

    • Provides resources for listing and accessing various order-related documents.
    • Allows downloading PDF versions of specific documents.

  • Return Requests for Orders

    • Provides resources for listing returnable order positions.
    • Supports the creation of new return requests for one or more order positions.
    • Offers endpoints for listing return requests for a given order, their positions, and custom-attributes.
Document API

This section covers requests for accessing order-related documents provided by the IOM.
The requests require a properly configured and enabled IOM Order History Service.

/orders/{orderKey}/documents
GET: Returns all order-related documents

Description

This operation returns a list of all order-related documents provided by the IOM.

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.adapter.iomconnector.rest.capi.resource.order.document.OrderDocumentsResource.getAllDocuments()

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathorderKeystringExampleKeyRequired | The key or UUID to resolve a single item

Response

200 - OK

Array of LinkRO application/vnd.intershop.order-iom-ext.v1+json
/orders/{orderKey}/documents/creditnotes
GET: Returns all credit note documents

Description

This operation returns a list of all credit note documents provided by the IOM.

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.adapter.iomconnector.rest.capi.resource.order.document.OrderDocumentsResource.getCreditDocuments()

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathorderKeystringExampleKeyRequired | The key or UUID to resolve a single item

Response

200 - OK

Array of LinkRO application/vnd.intershop.order-iom-ext.v1+json
/orders/{orderKey}/documents/delivery
GET: Returns all delivery note documents

Description

This operation returns a list of all delivery note documents provided by the IOM.

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.adapter.iomconnector.rest.capi.resource.order.document.OrderDocumentsResource.getDeliveryDocuments()

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathorderKeystringExampleKeyRequired | The key or UUID to resolve a single item

Response

200 - OK

Array of LinkRO application/vnd.intershop.order-iom-ext.v1+json
/orders/{orderKey}/documents/invoicecreditnotes
GET: Returns all invoice credit note documents

Description

This operation returns a list of all invoice credit note documents provided by the IOM.

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.adapter.iomconnector.rest.capi.resource.order.document.OrderDocumentsResource.getInvoiceCreditDocuments()

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathorderKeystringExampleKeyRequired | The key or UUID to resolve a single item

Response

200 - OK

Array of LinkRO application/vnd.intershop.order-iom-ext.v1+json
/orders/{orderKey}/documents/invoices
GET: Returns all invoice documents

Description

This operation returns a list of all invoice documents provided by the IOM.

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.adapter.iomconnector.rest.capi.resource.order.document.OrderDocumentsResource.getInvoiceDocuments()

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathorderKeystringExampleKeyRequired | The key or UUID to resolve a single item

Response

200 - OK

Array of LinkRO application/vnd.intershop.order-iom-ext.v1+json
/orders/{orderKey}/documents/returnlabel
GET: Returns all return label documents

Description

This operation returns a list of all return label documents provided by the IOM.

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.adapter.iomconnector.rest.capi.resource.order.document.OrderDocumentsResource.getReturnLabelDocuments()

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathorderKeystringExampleKeyRequired | The key or UUID to resolve a single item

Response

200 - OK

Array of LinkRO application/vnd.intershop.order-iom-ext.v1+json
/orders/{orderKey}/documents/returnslip
GET: Returns all return slip documents

Description

This operation returns a list of all return slip documents provided by the IOM.

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.adapter.iomconnector.rest.capi.resource.order.document.OrderDocumentsResource.getReturnSlipDocuments()

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathorderKeystringExampleKeyRequired | The key or UUID to resolve a single item

Response

200 - OK

Array of LinkRO application/vnd.intershop.order-iom-ext.v1+json
/orders/{orderKey}/documents/{OrderDocumentResourceKey}
GET: Returns specific document

Description

This operation returns a specific document by its ID.

Java Method

public com.intershop.adapter.iomconnector.rest.capi.resourceobject.order.document.OrderDocumentRO com.intershop.adapter.iomconnector.rest.capi.resource.order.document.OrderDocumentResource.getDocument()

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathorderKeystringExampleKeyRequired | The key or UUID to resolve a single item
in pathOrderDocumentResourceKeystringExampleKeyRequired | The key or UUID to resolve a single item

Response

200 - OK

OrderDocumentRO application/vnd.intershop.order-iom-ext.v1+json
/orders/{orderKey}/documents/{OrderDocumentResourceKey}/download
GET: Returns PDF document

Description

This operation returns a PDF representation of a specific document by its ID.

Java Method

public jakarta.ws.rs.core.Response com.intershop.adapter.iomconnector.rest.capi.resource.order.document.OrderDocumentResource.download() throws java.io.IOException

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathorderKeystringExampleKeyRequired | The key or UUID to resolve a single item
in pathOrderDocumentResourceKeystringExampleKeyRequired | The key or UUID to resolve a single item

Response

200 - OK

Return Reason API

This section covers the retrieval of possible return reasons.
Requests in this section require a properly configured and enabled IOM RMA Service.
The requests are forwarded directly to the configured IOM, which must support the IOM RMA API 2.10 or later for all features to be fully available.

/orders/return-reasons
GET: Returns the return reasons

Description

This operation returns a list of the configured return reasons.

Java Method

public jakarta.ws.rs.core.Response com.intershop.adapter.iomconnector.rest.rma.v1.capi.resource.ReturnReasonResource.getShop2ReturnReasons(java.util.List) throws com.intershop.adapter.iomconnector.rma.internal.client.ApiException

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in querytypearrayRETReturns the return reasons by name of 1..n return types

Response

200 - OK

ShopReturnReason application/vnd.intershop.order-iom-ext.v1+json

400 - Bad Request

ErrorReport application/vnd.intershop.order-iom-ext.v1+json

404 - Not Found

502 - Bad Gateway

Return Request API

This section covers requests for managing return requests.
This includes retrieving a list of returnable positions, of return requests of an order, of custom attributes as well as the creation of return requests.
Requests in this section require a properly configured and enabled IOM RMA Service.
The requests are forwarded directly to the configured IOM, which must support the IOM RMA API 2.12 or later for all features to be fully available.
If the IOM used only supports RMA API version 2.11 or 2.10, certain resources will not be available and the corresponding request will return the HTTP status 404 (Not Found).
Further details can be found in the description and changelog of the IOM RMA REST API.

/orders/{orderKey}/return-requests
GET: Returns the return requests of an order

Description

This operation returns a list of return requests created for the given order.
It returns an empty list if no return request has been created yet.

Java Method

public jakarta.ws.rs.core.Response com.intershop.adapter.iomconnector.rest.rma.v1.capi.resource.ReturnRequestResource.getReturnRequests() throws com.intershop.adapter.iomconnector.rma.internal.client.ApiException

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathorderKeystringExampleKeyRequired | The key or UUID to resolve a single item

Response

200 - OK

ReadReturnRequest application/vnd.intershop.order-iom-ext.v1+json

404 - Not Found

502 - Bad Gateway

POST: Creates a return request for positions of an order

Description

This operation creates a new return request for one or more positions of an order.
A return request can only be created if no other return request has been accepted for the same position.

Java Method

public jakarta.ws.rs.core.Response com.intershop.adapter.iomconnector.rest.rma.v1.capi.resource.ReturnRequestResource.createReturnRequest(com.intershop.adapter.iomconnector.rma.internal.client.model.WriteReturnRequest) throws com.intershop.adapter.iomconnector.rma.internal.client.ApiException

Request Body

WriteReturnRequest */*

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathorderKeystringExampleKeyRequired | The key or UUID to resolve a single item

Response

201 - Created

400 - Bad Request

ErrorReport application/vnd.intershop.order-iom-ext.v1+json

404 - Not Found

502 - Bad Gateway

/orders/{orderKey}/return-requests/returnables
GET: Returns the returnable order positions to prepare the creation of a return request

Description

This operation returns a list of order positions that can be returned.
It returns the data that is necessary to enable a client to prepare the creation of a return request.

Java Method

public jakarta.ws.rs.core.Response com.intershop.adapter.iomconnector.rest.rma.v1.capi.resource.ReturnablesResource.getReturnableData() throws com.intershop.adapter.iomconnector.rma.internal.client.ApiException

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathorderKeystringExampleKeyRequired | The key or UUID to resolve a single item

Response

200 - OK

ReturnableData application/vnd.intershop.order-iom-ext.v1+json

404 - Not Found

502 - Bad Gateway

/orders/{orderKey}/return-requests/{returnRequestId}/custom-attributes
GET: Returns the custom attributes of a return request

Description

This operation returns a list of custom attributes for the given return request of the given order.
It returns an empty list in case no custom attributes were added to the return request.

Java Method

public jakarta.ws.rs.core.Response com.intershop.adapter.iomconnector.rest.rma.v1.capi.resource.ReturnRequestCustomAttributeListResource.getReturnRequestCustomAttributes() throws com.intershop.adapter.iomconnector.rma.internal.client.ApiException

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathreturnRequestIdinteger int64Required
in pathorderKeystringExampleKeyRequired | The key or UUID to resolve a single item

Response

200 - OK

ReadCustomAttribute application/vnd.intershop.order-iom-ext.v1+json

404 - Not Found

502 - Bad Gateway

/orders/{orderKey}/return-requests/{returnRequestId}/positions
GET: Returns the return request positions

Description

This operation returns a list of return request positions for the given return request of the given order.

Java Method

public jakarta.ws.rs.core.Response com.intershop.adapter.iomconnector.rest.rma.v1.capi.resource.ReturnRequestPositionListResource.getReturnRequestPositions() throws com.intershop.adapter.iomconnector.rma.internal.client.ApiException

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathreturnRequestIdinteger int64Required
in pathorderKeystringExampleKeyRequired | The key or UUID to resolve a single item

Response

200 - OK

ReadReturnRequestPosition application/vnd.intershop.order-iom-ext.v1+json

404 - Not Found

502 - Bad Gateway

/orders/{orderKey}/return-requests/{returnRequestId}/positions/{returnRequestPositionId}/custom-attributes
GET: Returns the return request position custom attributes

Description

This operation returns a list of custom attributes of a return request position of the given order.
It returns an empty list in case no custom attributes were added to the return request position.
[Requires IOM RMA API >= 2.12]

Java Method

public jakarta.ws.rs.core.Response com.intershop.adapter.iomconnector.rest.rma.v1.capi.resource.ReturnRequestPositionListResource.getReturnRequestPositionCustomAttributes(long) throws com.intershop.adapter.iomconnector.rma.internal.client.ApiException

Request Body

--

Request Parameters

LocationNameFormatDefaultExampleDescription
in pathreturnRequestPositionIdinteger int64Required
in pathreturnRequestIdinteger int64Required
in pathorderKeystringExampleKeyRequired | The key or UUID to resolve a single item

Response

200 - OK

ReadCustomAttribute application/vnd.intershop.order-iom-ext.v1+json

404 - Not Found

502 - Bad Gateway

Request and Response Object Schemata
ErrorReport application/vnd.intershop.order-iom-ext.v1+json{
  • "status":
    integer
    The HTTP-status code applicable to this problem, expressed as a string value | Format: int32 | Example: 400
  • "errors":
    array
    An array of Error objects.
    [
    Error
    {
    • "code":
      string
      Required | The code of the error | Example: VALIDATION_EXCEPTION
    • "message":
      string
      Required | The message of the error | Example: Attribute XYZ is mandatory
    • "value":
      object
      The value which caused the error
    }
    ]
}
LinkRO application/vnd.intershop.order-iom-ext.v1+json[
LinkRO: A Link pointing to a resource
{
  • "name":
    string
    The name of the returned element
  • "type":
    string
    Readonly | This is a constant: Link | Example: Link
  • "attributes":
    array
    An array of ResourceAttribute objects. The list of attributes
    [
    ResourceAttribute: An attribute
    {
    • "name":
      string
      The attribute's name
    • "type":
      string
      This is a constant: ResourceAttribute | Example: ResourceAttribute
    • "value":
      object
      The attribute's value.
    }
    ]
  • "uri":
    string
    The URI
  • "relation":
    string
    The relation of the link | Documentation: Link Relations (www.iana.org) | Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
  • "title":
    string
    The title of the link
  • "description":
    string
    The description of the link
  • "itemId":
    string
    The ID of the linked item
  • "attribute":
    object
    A ResourceAttribute object. An attribute
    {
    • "name":
      string
      The attribute's name
    • "type":
      string
      This is a constant: ResourceAttribute | Example: ResourceAttribute
    • "value":
      object
      The attribute's value.
    }
}
]
OrderDocumentRO application/vnd.intershop.order-iom-ext.v1+json{
  • "name":
    string
    The name of an element
  • "type":
    string
    Readonly | The type of the element. This is normally a constant that can be used to differentiate elements by their type.
  • "downloadLink":
    string
  • "creationDate":
    string
    Format: date-time
  • "id":
    string
}
ReadCustomAttribute application/vnd.intershop.order-iom-ext.v1+json{
  • "key":
    string
    Required | The key of a custom attribute. | Example: Example Key
  • "value":
    string
    Required | The value of a custom attribute. | Example: Example Value
  • "id":
    integer
    The custom attribute identifier. | Format: int64 | Example: 10000
}
ReadReturnRequest application/vnd.intershop.order-iom-ext.v1+json{
  • "type":
    string
    Required | The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: PICKUP | Possible Values: RETURNPICKUP
  • "rmaNumber":
    string
    The actual number of the return request. | Example: 10901095
  • "comment":
    string
    The comment of the return request. | Example: The battery is draining quickly
  • "id":
    integer
    The return request identifier. | Format: int64 | Example: 10000
  • "creationDate":
    string
    The date when the return request was created. | Format: date-time | Example: 2018-02-27T07:15:37.562Z
  • "shopOrderNumber":
    string
    The order number as used by the shop. | Example: 20180303123
  • "shopName":
    string
    The name of the shop. | Example: Test Shop US DE
  • "supplierOrderNumber":
    string
    The order number as used by the supplier. | Example: 20180303321
  • "supplierName":
    string
    The name of the supplier. | Example: Test Supplier US DE
  • "status":
    string
    The technical status of the return request. | Example: CLOSED | Possible Values: ACCEPTEDCLOSEDDO_APPROVEDO_CLOSEINITIALREJECTED
  • "businessStatus":
    string
    The business status of the return request. | Example: ACCEPTED | Possible Values: ACCEPTEDIN_APPROVALREADY_TO_APPROVEREJECTEDUNKNOWN
}
ReadReturnRequestPosition application/vnd.intershop.order-iom-ext.v1+json{
  • "positionNumber":
    integer
    Required | The position number as used by the shop. | Format: int32 | Example: 1
  • "productNumber":
    string
    Required | The product number as used by the shop. | Example: 20180303123
  • "reason":
    string
    Required | The reason for the return. | Example: RET100
  • "quantity":
    integer
    Required | The quantity of the related product by the shop. | Format: int32 | Example: 1
  • "id":
    integer
    The return request position identifier. | Format: int64 | Example: 10000
  • "productName":
    string
    The product name as used by the shop. | Example: test_product_1
  • "supplierProductNumber":
    string
    The article number as used by the supplier. | Example: 20180303123
  • "customAttributes":
    array
    An array of ReadCustomAttribute objects.
    [
    ReadCustomAttribute: Represents a custom attribute (key/value pair) of a return request from an order of a shop.
    {
    • "key":
      string
      Required | The key of a custom attribute. | Example: Example Key
    • "value":
      string
      Required | The value of a custom attribute. | Example: Example Value
    • "id":
      integer
      The custom attribute identifier. | Format: int64 | Example: 10000
    }
    ]
}
ReturnableData application/vnd.intershop.order-iom-ext.v1+json{
  • "positions":
    array
    Required | An array of ReturnableDataPosition objects. Possible order positions / line items to return
    [
    ReturnableDataPosition: Order position / line item to return
    {
    • "positionNumber":
      integer
      Required | Order position number as used by the shop | Format: int32 | Example: 3
    • "quantity":
      integer
      Required | Maximum return quantity | Format: int32 | Example: 1
    • "items":
      array
      An array of ReturnableDataItem objects. Further information for each single product
      [
      ReturnableDataItem: Further information for a single product
      {
      • "productSerialNumber":
        string
        Required | Serial number of the item to return | Example: 667002
      }
      ]
    • "product":
      object
      Required | A ReturnableDataProduct object. Product of a still returnable order position
      {
      • "number":
        string
        Required | Shop specific product number, if not available the the IOM internal product number | Example: 100-0001
      • "name":
        string
        Required | The name of an element | Example: Demo Product
      }
    }
    ]
}
ShopReturnReason application/vnd.intershop.order-iom-ext.v1+json{
  • "name":
    string
    Required | The name of an element | Example: RET010
  • "description":
    string
    Description of return reason | Example: return of goods / general
  • "type":
    string
    The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: RET
}
WriteReturnRequest */*{
  • "type":
    string
    Required | The type of the element. This is normally a constant that can be used to differentiate elements by their type. | Example: PICKUP | Possible Values: RETURNPICKUP
  • "rmaNumber":
    string
    The actual number of the return request. | Example: 10901095
  • "comment":
    string
    The comment of the return request. | Example: The battery is draining quickly
  • "positions":
    array
    Required | An array of WriteReturnRequestPosition objects.
    [
    WriteReturnRequestPosition: Represents a return request position of a return request from an order of a shop.
    {
    • "positionNumber":
      integer
      Required | The position number as used by the shop. | Format: int32 | Example: 1
    • "productNumber":
      string
      Required | The product number as used by the shop. | Example: 20180303123
    • "reason":
      string
      Required | The reason for the return. | Example: RET100
    • "quantity":
      integer
      Required | The quantity of the related product by the shop. | Format: int32 | Example: 1
    • "items":
      array
      An array of WriteReturnRequestItem objects.
      [
      WriteReturnRequestItem: Represents a return request item of a return request from an order of a shop.
      {
      • "productSerialNumber":
        string
        Required | The serial number of the product. | Example: W88401231AX
      }
      ]
    • "customAttributes":
      array
      An array of WriteCustomAttribute objects.
      [
      WriteCustomAttribute: Represents a custom attribute (key/value pair) of a return request from an order of a shop.
      {
      • "key":
        string
        Required | The key of a custom attribute. | Example: Example Key
      • "value":
        string
        Required | The value of a custom attribute. | Example: Example Value
      }
      ]
    }
    ]
  • "pickupAddress":
    object
    A WritePickupAddress object. Represents a pickup address related to the return request from an order of a shop.
    {
    • "company":
      string
      The name of the company of the pickup adress. | Example: Intershop Communication AG
    • "firstName":
      string
      The first name related to the pickup address. | Example: John
    • "lastName":
      string
      Required | The last name related to the pickup address. | Example: Doe
    • "streetName":
      string
      Required | The name of the street related to the pickup address. | Example: Alexstraße
    • "houseNumber":
      string
      The house number related to the pickup address. | Example: 28
    • "postCode":
      string
      Required | The post code related to the pickup address. | Example: 12053
    • "city":
      string
      Required | The city name related to the pickup address. | Example: Berlin
    • "countryCode":
      string
      Required | The ISO 3166-1 alpha-3 code for the country name related to the pickup address. | Example: DEU
    • "district":
      string
      The district related to the pickup address. | Example: Berlin
    • "additionFirstLine":
      string
      The first addition line related to the pickup address. | Example: Finanz
    • "additionSecondLine":
      string
      The second addition line related to the pickup address. | Example: 3.Floor
    }
  • "contactPersons":
    array
    An array of WriteContactPerson objects.
    [
    WriteContactPerson: Represents a contact person of the return request from an order of a shop.
    {
    • "company":
      string
      The name of the company of the contact person. | Example: Intershop Communication AG
    • "firstName":
      string
      The first name of the contact person. | Example: John
    • "lastName":
      string
      Required | The last name of the contact person. | Example: Doe
    • "phoneNumber":
      string
      The phone number of the contact person. | Example: 0176 04069077
    • "emailAddress":
      string
      Required | The email address of the contact person. | Example: john.doe@intershop.com
    • "language":
      string
      The preferred correspondence language to answer the contact person (ISO-639-1). | Example: en
    }
    ]
  • "customAttributes":
    array
    An array of WriteCustomAttribute objects.
    [
    WriteCustomAttribute: Represents a custom attribute (key/value pair) of a return request from an order of a shop.
    {
    • "key":
      string
      Required | The key of a custom attribute. | Example: Example Key
    • "value":
      string
      Required | The value of a custom attribute. | Example: Example Value
    }
    ]
}
Disclaimer
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.
The Intershop Knowledge Portal uses only technically necessary cookies. We do not track visitors or have visitors tracked by 3rd parties. Please find further information on privacy in the Intershop Privacy Policy and Legal Notice.
Home
Knowledge Base
Product Releases
Log on to continue
This Knowledge Base document is reserved for registered customers.
Log on with your Intershop Entra ID to continue.
Write an email to supportadmin@intershop.de if you experience login issues,
or if you want to register as customer.