Customizable Option values do not end up in REST API call /orders (orderRepositoryV1)

[amenk]

Summary

We have added a customizable option text area using the admin backend, which is filled with text when adding the product to the cart. Later we export the order to an ERP via the REST interface.

In the resulting XML or JSON, the attribute is completely missing. In the backend, the information is there.

We believe, that the information in the backend, should also be exposed via the API.

Examples

curl -X GET --header "Accept: application/xml" --header "Authorization: Bearer $B" "http://shop.example.com.localhost/rest/english/V1/orders/131"

curl -X GET --header "Accept: application/json" --header "Authorization: Bearer $B" "http://shop.example.com.localhost/rest/english/V1/orders/131"

Proposed solution

Solution would be to put those attributes to the REST result.

I do not yet have a solution code wise (can try to make a pull request).

Magento 2.2.5

[magento-engcom-team]

Hi @amenk. Thank you for your report. To help us process this issue please make sure that you provided the following information:

• [x] Summary of the issue
• [x] Information on your environment
• [x] Steps to reproduce
• [x] Expected and actual results

Please make sure that the issue is reproducible on the vanilla Magento instance following Steps to reproduce. To deploy vanilla Magento instance on our environment, please, add a comment to the issue:

@magento-engcom-team give me $VERSION instance

where $VERSION is version tags (starting from 2.2.0+) or develop branches (for example: 2.3-develop). For more details, please, review the Magento Contributor Assistant documentation.

@amenk do you confirm that you was able to reproduce the issue on vanilla Magento instance following steps to reproduce?

• [x] yes
• [x] no

[magento-engcom-team]

Hi @engcom-backlog-nazar. Thank you for working on this issue. In order to make sure that issue has enough information and ready for development, please read and check the following instruction: :point_down:

• [x] 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).

  Details

  If the issue has a valid description, the label Issue: Format is valid will be added to the issue automatically. Please, edit issue description if needed, until label Issue: Format is valid appears.

• [x] 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue. If the report is valid, add Issue: Clear Description label to the issue by yourself.

• [x] 3. Add Component: XXXXX label(s) to the ticket, indicating the components it may be related to.

• [x] 4. Verify that the issue is reproducible on 2.3-develop branch

  Details

  - Add the comment @magento-engcom-team give me 2.3-develop instance to deploy test instance on Magento infrastructure.
  - If the issue is reproducible on 2.3-develop branch, please, add the label Reproduced on 2.3.x.
  - If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!

• [x] 5. Verify that the issue is reproducible on 2.2-develop branch.

  Details

  - Add the comment @magento-engcom-team give me 2.2-develop instance to deploy test instance on Magento infrastructure.
  - If the issue is reproducible on 2.2-develop branch, please add the label Reproduced on 2.2.x

• [ ] 6. Add label Issue: Confirmed once verification is complete.

• [ ] 7. Make sure that automatic system confirms that report has been added to the backlog.

[amenk]

We were able to reproduce it with Vanilla Magento CE 2.2.6

[amenk]

A current workaround is to write an own module which copies the custom options to the API - but I feel this should be done in the core already, as the custom options are a core feature

[amenk]

https://magento.stackexchange.com/a/243721/81

[sdzhepa]

Hello @amenk

According to the label "Feature Request" this ticket has been moved into "community-features" track

Thank you for collaboration

[amenk]

Anybody who wants to implement can ping me ... I can provide a custom module solving this issue (but having too much customized code, so I do not want to publish it, yet, neither have the time to contribute to the core ATM). But always happy to help.

[colinzeal109]

Anybody who wants to implement can ping me ... I can provide a custom module solving this issue (but having too much customized code, so I do not want to publish it, yet, neither have the time to contribute to the core ATM). But always happy to help. @amenk I'm interested in the module. Most of my products use the customizable options and I'd love to be able to export them with the API. Thanks.

[amenk]

@colinzeal109 can you drop me an eMail to a dot menk at imi dot de to send you "IMI_OptionsToOrderInterface" .. would be great if you can make it ready for a general purpose and publish it on GitHub then