Tipser can integrate with a merchant commerce system in a number of ways, either by the Tipser Merchant Order API , by connecting through any of the prebuilt order integrations Tipser already have, through merchant REST APIs, as well as through file based XML data exchange.
In all of the order integrations, there are a few important methods that should be involved throughout the order process.
Endpoint that creates order in target system. Input data and format dependent on target system.
Minimum required data exchange
- Product variant id / SKU ID
- Quantity of products
- Shipping address
- Shipping alternative (unless there is only one option for the merchant)
- Payment provider (optional)
Minimum required return data
- Order identifier/line item identifier
- Status of order (acknowledged, created, failed, etc.)
Check order status
Endpoint to check status for order. Target systems order statuses needs to be mapped to the following Tipser statuses. If target system handle order status on line item level, same statuses will be used but for individual line items. For shipped orders tracking id should be provided in the API response.
Set order status
[Optional] Endpoint to set order status, used to set orders to cancelled after contact with Tipser customer support.
Asynchronous data synchronization
To keep the systems in sync the following tasks will run in the Tipser system using the target system endpoints described above.
Update Tipser system order status
Scheduled task to read order status from target system to Tipser. Typically run every 5 min.
Update target system status
Scheduled task to (if used) set order status in target system. Typically run every 5 min.