Customer Success Portal
            Knowledge Base Truvi Commerce Resources API

            Orders List API


            This API will return order list along with order items, customer info, billing address, shipping address and shipping method name if applicable.


            Parameters for this API

            • offset - Offset can be used to start order listing from a particular starting point in orders record which is already sorted by purchase date. By default it will start fetching records from 0 if not provided.

            • Limit - Limit can be used to fetch particular number of orders from the database. For example limit 100 will return 100 orders as result. By default it will take 100 as limit if not provided

            • from_date (optional – can be posted or used in query string) - Purchase date starts from. It will pull record starting from the sent from_date date.

            • to_date (optional – can be posted or used in query string) - Purchase date end to. It will pull record before the sent to_date date.

            • payment_status (optional – can be posted or used in query string) - To search the record with specific payment status. Following values can be sent with this parameters (Authorized,Declined,Settled,Expired,Refunded,Partially Refunded,Voided,Cash)

            • order_type (optional – can be posted or used in query string) - To search the orders of specific type. Following values can be sent with this parameter (Internet,Phone,Mail,Fax,InPerson,Club)

            • shipment_type (optional – can be posted or used in query string) - To search records for specific shipment types. You can use delivery or pickup with this parameter. 



            Updated: 26 Aug 2019 03:39 AM
            Helpful?  
            Help us to make this article better
            0 0