Your system should validate and import submitted Orders into the ERP. Then, as the final step in the Order flow, OrderConfirmation objects should be returned to the RepSpark API. This updates the Order's StatusId to Valid (4), which will be reflected in the UI to sales representatives and customers.

Depending on the ERP and other processes in place, some confirmations might be made hours after submitted Orders are exported from the API to the ERP, while others may be immediate.

The OrderConfirmation resource uses the POST HTTP verb. This sync should only be used with the Delta sync mode header, as you will only want to send confirmations for the Orders you recently confirmed and not every confirmation ever.

The payload for the most part will be arrays with items:

{  
    "RepSparkOrderNumber": 123,  
    "ErpOrderNumber": "SO32221"  
}

ErpOrderNumber is a unique, arbitrary identifier from the ERP that can be used to match Orders in RepSpark with the corresponding Orders in the ERP. It is an optional attribute but strongly recommended. The ErrorMessage attribute can be added if for whatever reason the Order fails to validate on the ERP side. ErrorMessage is optional but recommended if available, for potential troubleshooting purposes.

🕑
Recommended sync cadence
Immediately after orders are confirmed as valid in the ERP.

200OK

400Bad Request

401Forbidden

404Not Found

409Conflict

500Internal Server Error