TI-API: Store orders (/store/orders) API suite - order status clarifications

Hi Siret,

The statuses that are found in the FAQ ( https://e2e.ti.com/support/enterprise-automation-integration-group/enterprise-automation-integration/f/enterprise-automation-integration-forum/1159378/faq-ti-api-api-order-status-codes-and-meanings/4358978?tisearch=e2e-sitesearch&keymatch=status%20shipped#4358978 )   include ORDER PROCESSING and PAYMENT statuses.    It is a comprehensive list of all of the statuses and descriptions, but, I need to research and possibly add "Acceptance Required" to the list.  Since it is listed as a possible option, please include it in your list of options as well.

Here are the different orderCreateResponse statuses:  

• For each lineItem, if there is an error with the lineItem, you could receive one of these statuses:   'Submitted' or 'Shipped'.
• For the order, you could receive one of these statuses:  Processing, Acceptance Required, Created, Submitted, Cancelled, In-Work, Complete

The orderStatuses are a subset of the FAQ statuses.   

IMPORTANT: Use the syntaxing that is published on the API portal/spec (e.g. "In-Work")   

We do not have published workflows, but, we do provide you with a list of all of the possible errors codes and their meanings:  

Hope this helps!    Let me know if you have any other questions, otherwise, I will close this thread.

Regards,

Faye

Hi Faye,

thanks for the tempestive response, ok so we can assume that the list in the FAQ (+ "Acceptance Required") is the complete and official? I have a couple of other questions:

• Defining a workflow is crucial for us since our processes need to know if the status of the order is in a error status and needs manual intervention, or it is in a elaboration status and only needs further updates or maybe it is in a final status and it won't change anymore. So we need to know at least which statuses are related to the payment phase (which we suppose is the first?) and once passed they won't appear anymore, which statuses are related to the elaboration and shipment phase and don't need any intervention, and which statuses are considered final so they need manual intervention or other kind of actions. All these kind of info would be very appreciated, consider that our goal is to automatically handle an order from its placement to its closure (ASN info and invoices retrieval, everything included), so our processes will constantly retrieve order information and for every status they need to know exactly what to do as next step.
• Can you please also confirm the syntaxing of all the statuses, some of them are not reported in the API portal and we don't understand the naming convention (In-Work, Acceptance Required, PAYMENT_AUTHORIZED, PAYMENT COMPLETED)?

Many thanks in advance.

Hi Siret,

To follow up on your questions above:

• With regards to a workflow, on our Getting Started page, we provide an overview of the ordering flow.   The flow shows the "order placing" status codes.  When you see statuses 200 or 201 - this will always be a successful API call, during the ordering process (ASN and Invoice too).  Any other status code is an error.   Each API will show you the status codes that are considered successful  (normally 200, 201, or 204).  But, please check each API to confirm.
• With regards to syntaxing, each API can be different with their syntaxing.  To ensure you have consistent syntaxing, you could use the "lower" or "upper" function which will always return consistent formatting for you.    When you ask about the "naming convention", PAYMENT_AUTHORIZED, PAYMENT COMPLETED definitions are located on the E2E page. In-Work has the same definition as "In WORK" on the E2E page.   I need to find out the meaning of "Acceptance Required" and will get back to you on this.

Regards,

Faye

Hi Faye,

first of all thanks for the replay, I'll write a quick recap of every status just to be clearer, can you please confirm or explain these last doubts?

Processing -> is it always the first status? (the one and only status retrieved by the post order test endpoint /store/orders/test, actually the endpoint returns PROCESSING), TI has accepted the order (response code 201) but it is elaborating the payment?

Acceptance Required -> ? 

Created -> the order has been accepted and the payment as well, so we can consider the order as confirmed or after this status the order can still end in status Cancelled? 

Submitted -> it is always after the status Created? Can we always consider it as a pending status between the creation and the completion of the order?

Cancelled -> this status can appear anytime (for example after the created/submitted/in-work statuses)?

In-Work -> it is always after the status Created? Can we always consider it as a pending status between the creation and the completion of the order?

Complete -> last status? all the invoices are ready to be retrieved from the dedicated API?

These are all the values that the field orderStatus can assume? 

Many thanks in advance.

Hi Siret,

Let me provide clearer meanings for this and send it back later today.  I want to make sure it's aligned with the system owner(s).

Regards,

Faye

Hi Siret,

I spoke with a peer and we tried to walk through the order processing flows based on the payment method.  Note:  This is our interpretation, so, we might have made a mistake(s) and reserve the right to make correction.   Hopefully this will be sufficient for the purposes that you need.

Once an API order is submitted, the order could display a different status, depending on how quickly the order processes and your payment method (Apruve, Line of Credit, Bank Transfer, etc..).    This is a rough summary (based on what we can put together).   

 Important:  ** We reserve the right to be corrected;  This is our rough summary of the workflow;  **

 -------------------------

High-level Order flows, based on payment method:

 Apruve or Line of Credit:    Created --> Processing* --> In Work  --> Shipped --> Complete

 Bank Transfer:  Submitted --> Payment Pending** --> Approved  --> Complete

 Statuses that apply to all types of payment methods:

• Cancelled
• On Hold

 Notes:

1. * Validate payment method
2. ** Requires manual validation and approval
3. Cancelled – For Apruve or line of credit orders, an order must be cancelled before Shipped

 ================================

 Payment statuses:

Options that apply to all payment methods:

• Processing
• Processing_Error

Bank Transfer statuses:

• Payment Pending
• Payment_Authorized
• Payment Completed

Other:

• Acceptance Required – A status only meant for sample orders. 

Hope this helps!  Let me know if you need anything else. 

Faye