HIhitpayapp

Get Orders

Get and filter the orders

get/v1/orders

Request

  • Base URL
    https://api.hit-pay.com
  • URL
    https://api.hit-pay.com/v1/orders
  • Auth
    none declared. Required headers: X-BUSINESS-API-KEY

Query parameters

perPageinteger
version'1.0' | '2.0'

Order version: 1.0 or 2.0. Return all orders as default

keywordsstring

Search for fields: amount ,created_at ,order id, remark, customer_name

statuses[]'completed' | 'sent' | 'draft' | 'expired' | 'canceled'

The available status: completed, sent, draft, expired, canceled

dateFromstring

Example: 2023-04-18

dateTostring

Example: 2023-04-18

withstring

If we want to show the product or charge detail=> add the value: products or charges. For both: products,charges

Headers

X-BUSINESS-API-KEYstring required
Example:b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d

Response

200

idstring
order_display_numberinteger
business_idstring
channelstring
versionstring
customer_idunknown
business_customer_idunknown
customerunknown
customer_pickupboolean
currencystring
order_discount_nameunknown
statusstring
remarkstring
created_atstring
updated_atstring
closed_atunknown
location_idunknown
locationunknown
business_user_idstring
slot_dateunknown
slot_timeunknown
messagesunknown
couponunknown
payment_statusunknown
fulfilment_statusstring
line_items_totalinteger
order_discount_amountinteger
line_item_discount_amountinteger
line_item_tax_amountinteger
additional_discount_amountinteger
total_discount_amountinteger
line_item_priceinteger
shipping_amountinteger
total_coupon_amountinteger
amountinteger
subtotalinteger

Changes

No recorded changes to this operation across all 8 revisions of this API.