• State
  • Locked Locked
  • Replies 3 replies
  • Subscribers 2 subscribers
  • Views 453 views
  • Users 0 members are here
Support feedback
Options
Options
Similar topics

This thread has been locked.

If you have a related question, please click the "Ask a related question" button in the top right corner. The newly created question will be automatically linked to this question.

TI-API: examples in documentation do not match with the schemas

Petr Neuman
Prodigy 241 points

The examples in the documentation do not match the schemas. For example, on the website

https://api-portal.ti.com/store-order-api#/TI%20store%20production%20order/post_store_orders

https://api-portal.ti.com/store-order-api#/TI%20store%20test%20order/post_store_orders_test

In the example is "customerItemComments" inside "lineItems".

In the schema is "customerItemComments" next to the same level as "lineItems".

https://api-portal.ti.com/store-order-api#/TI%20store%20production%20order/get_store_orders__orderNumber_

In the example is "lineItems" but in the schema is only "numberOfLineItems" without detail about items

Can you check all the schema sections in the documentation for more inaccuracies?

  • 0
    TI__Genius 10401 points

    Hi Petr,

    Thanks for sharing your findings. We'll check these out and make needed corrections within the next week.

    Thanks and best regards,
    Paul

  • 0 in reply to Paul King
    Prodigy 241 points

    These schemas are still wrong in the documentation.

  • 0 in reply to Petr Neuman
    TI__Genius 10401 points

    Petr,

    Sorry for the delay. I updated the schema so the the customer line item comments are within the line item objects, aligning with the examples that were correct. Only customer order comments is at the top level of an order.

    What you are seeing with respect to numberOfLineItems is the schema for the GET /store/orders summary response. The summary contains an array of all orders placed within a timeframe, but does not contain all of the line item details for each order. The GET /store/orders/{orderNumber} request will provide the details, and I see that the schema for the order details response is missing from the spec. I'll leave this issue open until we can update it.

    Thanks again,
    Paul

**Attention** This is a public forum