Adding a Text Modifier via Orders API

Questions
1

Hello,

We have certain items that include a text modifier, but cannot find a way to properly submit them on the line item.

I checked the OrderLineItemModifier reference and found two things:

  1. I couldn’t find a field name to submit the text value under
  2. There isn’t a related catalog_object_id to submit, where there would normally be one in the modifiers list (a CatalogModifier ID). When submitting the CatalogModifierList ID which is the only other relevant ID could find to use, I get the error (removed specific ID):
"Modifier option with catalog object ID `XXXX` not found."

Is there a proper way to submit values for a text based modifier on a line item in an order?

Thanks!

2

:wave: I’m Square Dev AI, here to help answer your question!
Based on the information you’ve provided, the following documentation will help answer your question:

Additional Documentation

Catalog API
Build a Simple Catalog
Create Orders

If this documentation helped you find a solution, please check the box indicating that this reply solves the problem.
Otherwise one of our Developer Advocates will provide additional assistance shortly.

3

At this time the Orders API doesn’t currently support text modifiers. We’re constantly working to improve our features based on feedback like this, so I’ll be sure to share your request to the API product team. :slightly_smiling_face:

1 Like
4

Every restaurant we’re working with has a text modifier on every product for notes/instructions. To try from a slightly different angle, is there some other way we can send text or notes along with products through other means, such as a different api endpoint or updating an order after it’s submitted? Any possible way to do so programmatically?

5

At this time the only other way to send information on an order that will be visible to the seller would be to add it as a note on the order line items. :slight_smile:

1 Like