System order status query

AyMINE supports the ability to automatically get order status from clients

• Terminology
• Order query
• Query API structure:
• Query Frequency
• Order STatus (oper=ost) function

Terminology

• User within this chapter means an organization/firm that uses AyMINE to automate processes
• Client means a client of the user – a firm that has been made available by API or client portal services

Order query

The exact address to get order status is given to customers by agreement with AyMINE users.

Query API structure:

• AyMINE address or unique address (if the system is run under the user's domain)
• Unique service address
• Query parameters
• Service ID (ID can be changed at any time in the system settings to block the service)
• Client ID (To the client, the allocation ID is one for all services provided in the client settings. By changing or cancelling the allocated ID, the service can be blocked/enabled for a specific client)
• oper – one of the interface operations
• enc – reply encoding: plain – plain text, b64 – encoded in base64
• format – return reply format: xml, js

Query Frequency

The API does not monitor how often a query is sent, but watches

• Maximum allowed number of queries per hour – will return an error code after exceeding
• Maximum allowed number of queries per day – will return an error code after exceeding
• Number of failed logins from the IP address – after exceeding, the interface will stop responding completely and the address will be blocked

Limits are set individually. Generally, the recommendation applies, do not call the interface more often than 1 x 2 minutes.

Order STatus (oper=ost) function

Order states returned:

• CE – (Customer / Error) – The order requires completion/repair via the customer portal. Until it is corrected and confirmed by the customer on the portal, it is not processed internally
• PR – (Prepare) – The order is being prepared internally or for some reason (e.g. missing goods) cannot be included in the shipment
• DL – (Delivery) – The order is already being delivered
• CO – (Completed) – The order has been processed and the goods delivered, The order is reclassified to this state upon confirmation that it has been handed over to the final recipient. In case of goods being taken over for sale, the state is changed upon receipt
• DE_ – (Deleted) – Excluded from processing

According to the agreement, the interface can return additional information:

• Selected transport type
• Scheduled delivery date (date + time)
• Payment status