Document Properties
Kbid28E587
Last Modified04-Feb-2020
Added to KB12-Apr-2018
Public AccessEveryone
StatusOnline
Doc TypeGuidelines, Concepts & Cookbooks
Product
  • ICM 7.9
  • ICM 7.10

Concept - Order Fulfillment Status Import

1 Introduction

This document gives an overview about the Intershop 7 Order Status Import. The principle focus of the Order Status Import is to provide a way to external systems (e.g., ERP system) to update an order in Intershop 7, so that it reflects the current processing state. The Order Status Import is used to update the status of orders, including:

  • Order processing status
  • Payment transactions status
  • Line item fulfillment status

1.1 Order Export vs. Order Status Import

In contrast to previous Enfinity Suite 6.x versions, Intershop 7 does not use identical XML schemata for Order Export and Order Status Import. The reason for this is that Intershop 7 does not implement a real import of orders neither created by other Intershop 7 instances nor by any external systems.  

1.2 References

For exporting orders in Intershop 7 see:

2 Status Values

Some of the status values which are described below are based on the Intershop 7 eCommerce reference process and only reflect a demo scenario. They are not mandatory to run the system. Status values which are created by the Intershop 7 system or which the system is dealing with (processes based on it) are in bold type. Other status values are only listed due to backward compatibility reasons.

Basically, every Intershop 7 customer has the freedom to use its own status values within its own project.

2.1 Order Status Values 

The following order status values are supported in Intershop 7 by default. Listed order status values are based on the definitions of the StateGroup 'OrderStatus'.

Note

There are some state values that are either not used in Intershop 7 anymore or that are only used for internal processing.

Order StatusStatus IDNumeric
Code
Used in
Order Status Import
Description
createdCREATED0

The merely internal state an order has for a very short time after its creation.

Note

This status value is only an internal setting that should not be set in the context of the Order Status Import.

pendingPENDING2
The order is waiting for payment.
newNEW3

The order creation has been finished, but has not been exported by the Order Export yet.

Note

This status is set internally only as a result of a successful Order Creation. This means all sorts of checks (e.g., items are deliverable; creditworthiness of the customer, availability of the shipping method for the desired destination region etc.) were successfully completed. This status should not be set in the context of the Order Status Import.

(open)(OPEN)(4)

This status is for backward compatibility reasons only. It is no longer used by Intershop 7.

completedCOMPLETED5X

This status is for backward compatibility reasons only. It is no longer used by Intershop 7.

Order handling is completely finished. This means that ordered items have been shipped to the customer and:

  • The maximum period of time granted for returning delivered order items has been exceeded.
  • The customer has partially or completely returned ordered items.
  • All payment transactions (e.g., capturing, refund) for the order are completed.

Note

Intershop 7 provides no out of the box capability to mark an order completed. COMPLETED is only a theoretical status of the Intershop 7 eCommerce reference process and used for a demo scenario.


cancelledCANCELLED6

The order has been cancelled by the customer in the web shop storefront, but has not been exported by the Order Export yet.

Note

This status may also be set by Order Status Import. An Intershop 7 standard system will export an order marked as cancelled afterwards. 

(rejected)(REJECTED)(7)
This status is for backward compatibility reasons only. It is no longer used by Intershop 7.
in progressINPROGRESS8

The order has been exported by the Order Export.

Note

This status is set by the Order Export

cancelled and exportedCANCELLEDANDEXPORTED9

The order has been cancelled by the customer in the web shop storefront. After cancellation, the order has been exported.

Note

This status is set internally only as a result of an Order Export and should not be set in the context of the Order Status Import.


not deliverableNOTDELIVERABLE10X

This status is for backward compatibility reasons only. It is no longer used by Intershop 7.

The order is not deliverable for any reason, e.g., incomplete or wrong address data.

Note

Intershop 7 provides no out of the box capability to mark an order as not deliverable. NOTDELIVERABLE is only a theoretical status of the Intershop 7 eCommerce reference process and used for a demo scenario.


deliveredDELIVERED11X

This status is for backward compatibility reasons only. It is no longer used by Intershop 7.

Ordered items have been delivered to the customer.

Note

Intershop 7 provides no out of the box capability to mark an order as delivered. DELIVERED is only a theoretical status of the Intershop 7 eCommerce reference process and used for a demo scenario.


returnedRETURNED12X

This status is for backward compatibility reasons only. It is no longer used by Intershop 7.

Ordered items have been returned by the customer.

Note

Intershop 7 provides no out of the box capability to mark an order as returned. RETURNED is only a theoretical status of the Intershop 7 eCommerce reference process and used for a demo scenario.


export failedEXPORTFAILED13

This status is not used in Order Status Import.

Note

This status is set internally only as a result of a failed Order Export and should not be set in the context of the Order Status Import.


payment cancelledPAYMENTCANCELLED15
The order has been cancelled due to a payment cancellation at an external provider page.
manual intervention neededMANUAL_INTERVENTION_NEEDED16
This may occur only if multiple payments are used to pay the order total amount. In the rare case that all payments are successful except the last one, the rollback of the successful payments is initiated. That means, the system tries to CANCEL, REDUCE or REFUND the payments. If this process is not supported/feasible or fails, the order is set to MANUAL_INTERVENTION_NEEDED and an administrator has to check and complete/void the payments manually.

The highlighted status values are created by Intershop 7 by default. Further order status values are not supported by default, because Intershop 7 does not provide any kind of further order management functionality. They must be implemented by the customer project itself.

In the following chart, the status transition of the Intershop 7 order statuses is shown. Imported status values and status values which are not created by Intershop 7 itself are not covered here.

order_states

2.2 Line Item Status Values 

The following line item status values are supported in Intershop 7 by default. The listed line item (fulfillment) status values are based on the definitions of the StateGroup 'SellerOrderProductLineItemStatus'.

Note

There are some status values that are either not used in Intershop 7 anymore or that are only used for internal processing. Some line item statuses are obviously the same like the order statuses after an operation. However, this must be not mandatory.

For instance: If the whole order will be cancelled, the order gets the status cancelled as well as the line item. If only one line item is cancelled, only the line item but not the whole order gets the cancelled status.

Line Item StatusStatus IDNumeric
Code

Used in Order Status Import

Description
newNEW10
Order creation has been finished, but has not been exported by the Order Export yet. The order gets the status NEW as well as the line item itself.
(confirmed)(CONFIRMED)(11)
This status is for backward compatibility reasons only. It is no longer used by Intershop 7.
(partly shipped)(PARTSHIPPED)(12)
This status is for backward compatibility reasons only. It is no longer used by Intershop 7.
(shipped)(SHIPPED)(13)
This status is for backward compatibility reasons only. It is no longer used by Intershop 7.
(rejected)(REJECTED)(14)
This status is for backward compatibility reasons only. It is no longer used by Intershop 7.
partly deliveredPARTDELIVERED20

This status is for backward compatibility reasons only. It is no longer used by Intershop 7.

Note

Intershop 7 provides no out of the box capability to set a line item as partly delivered. PARTDELIVERED is only a theoretical status of the Intershop 7 eCommerce reference process and used for a demo scenario.


deliveredDELIVERED21

This status is for backward compatibility reasons only. It is no longer used by Intershop 7.

Note

Intershop 7 provides no out of the box capability to set a line item as delivered. DELIVERED is only a theoretical status of the Intershop 7 eCommerce reference process and used for a demo scenario. 

cancelledCANCELLED22

The order has been cancelled by the customer in the web shop storefront, but has not been exported by Order Export yet. The order gets the status CANCELLED as well as the line item itself.

Note

Intershop 7 provides no out of the box capability to cancel a single line item and to set a single line item as cancelled. In the default Intershop 7 process the line item will be cancelled if the whole order is cancelled. 

in progressINPROGRESS23

The order was exported by Order Export. This means that each single line item also gets the status INPROGRESS.

Note

This status is set by the Order Export and will not be set manually or individually.


cancelled and exportedCANCELLEDANDEXPORTED24

The order has been cancelled by the customer in the web shop storefront. After cancellation, the order has been exported, e.g., due to marketing issues. This means that each single line item also gets the status CANCELLEDANDEXPORTED.

Note

This status is set by the Order Export and will not be set manually or individually.

2.3 Payment Transaction Status Values 

The following payment transaction status values are supported in Intershop 7 by default. The listed order status values are based on the definitions of the StateGroup 'PaymentTransaction'.

Note

There are some state values that are either not used in Intershop 7 anymore or that are only used for internal processing.

Payment Transaction
Status

Status ID

Numeric Code

Used in Order Status Import

Description
createdCREATED0

This is only an internal status the payment transaction has for a very short time after its creation.

Note

This status value is only an internal setting that should not be set in the context of the Order Status Import.
authorizedAUTHORIZED1

The payment amount is reserved, but is not booked yet.

Note

This status is set internally only by payment services.

(partly captured)(PARTCAPTURED)(2)(X)This status is currently not used by Intershop 7.
capturedCAPTURED3XThe payment amount is booked.
voided authorizationVOIDEDAUTHORIZATION4XAn authorized transaction is cancelled.
(voided capture)(VOIDEDCAPTURE)(5)
This status is currently not used by Intershop 7.
(marked)(MARKED)(6)
This status is currently not used by Intershop 7.
(settled)(SETTLED)(7)
This status is currently not used by Intershop 7.
(refunded)(REFUNDED)(8)
This status is currently not used by Intershop 7.
(voided authorization failed)(VOIDEDAUTHORIZATION_FAILED)(9)
This status is currently not used by Intershop 7.
(refund failed)(REFUND_FAILED)(10)
This status is currently not used by Intershop 7.

The statuses 5 - 10 are not used.

3 Order Status Import Schema

The XML schema for the Order Status Import is created from annotated Java classes using JAXB annotations (javax.xml.bind.annotation.*). The schema is generated by the Gradle tools during build process and published to the ${IS_SHARE}/system/impex/schema folder as a result of the Intershop 7 setup.

For details regarding the schema and the individual tags, take a look at Reference - Order Fulfillment Status Import. There you can also find the complete XSD file and a complete sample import file.

4 Business Configuration

To enable the order status import, perform the following steps:

  1. Log in to the Organization Mangement.
  2. Go to Sales Organizations.
  3. Choose the organization.
  4. Go to the Services tab.
  5. Open Order Status Import Services.
  6. Select the checkbox and click Enable.
  7. Log out from the Organization Management.
  8. Log in to Intershop Commerce Mangement.
  9. Go to Services.
  10. Click New to create a new service configuration.
  11. Choose Order Status Import Services and click Next.
  12. Enter a name, an ID and a description.
  13. Select the Active checkbox and click Next.
  14. Fill in the local file directory (of the application server) where the service looks for files to be imported and the desired file handling after successful order status import.
    There are two options:
    1. Delete, which deletes the successful imported file and
    2. Rename, which adds the suffix .imported to the successfully imported file.
  15. Share and activate the service and save the service configuration.
  16. Create a new order status import in the Orders tab and use the preliminary created service configuration as configuration type.
    Via the Scheduling tab it is possible to configure how and when the order status import job must be executed automatically.

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.

Customer Support
Knowledge Base
Product Resources
Support Tickets