Archiving and retrieving an order with origin information

Edit online

Order Service contains APIs that you can use to archive and retrieve orders against a unique set of attributes, such as order number, document type and enterprise code, or order identifier. However, when multiple Sterling Order Management System Software instances are integrated with one Order Service instance, you must also supply the origin id to uniquely identify an order while archiving and retrieving order data in Order Service. The origin identifier indicates a Sterling Order Management System Software instance where the order was originally created.

Important: To refer to the information about origin, see Configuring origin attributes. For more information on configuring, saving, and reading an order with origin information, see Saving and reading an order with origin information.

Archiving an order with origin information

Refer to the following example of archiving an order with origin information for a saved order.


{ 
 "orderID": {
  "id": "001",
  "origin":{
   "id": "OriginA"
   }
 },
 "orderPart": {
  "name": "order"
  }
}

Retrieving an order with origin information

Refer to the following example of retrieving an order with origin information for a saved order.


{ 
 "orderID": {
  "id": "001",
  "origin":{
   "id": "OriginA"
   }
 }
}