Sign in
Order

List of orders

Get list of orders. Get information of specific order

get/shops/{SHOP_ID}/orders

Path parameters

SHOP_IDinteger required
Example:4

Shop ID

Query parameters

page_sizeinteger
Example:30

Page size

page_numberinteger
Example:1

Page number

searchstring
Example:0999999999

Phone number, name of customer, note, ....

filter_status[]integer[]

Order status

[
  1,
  2
]
include_removedinteger

Include removed orders

updateStatus'inserted_at' | 'updated_at' | 'partner_inserted_at' | 'paid_at' | 'estimate_delivery_date' | 'picked_up_at' | 'first_delivery_at' | 'transfer_proof' | 'time_assign_seller' | 'time_assign_care' | 'time_assign_marketer' | '-1' | '0' | '11' | '20' | '1' | '12' | '13' | '8' | '9' | '2' | '3' | '16' | '4' | '15' | '5'
Example:inserted_at

Filter orders by time

startDateTimeinteger

Start date (unix timestamp)

endDateTimeinteger

End date (unix timestamp)

option_sort'inserted_at_desc' | 'inserted_at_asc' | 'last_updated_order_desc' | 'last_updated_order_asc' | 'last_update_status_at_desc' | 'last_update_status_at_asc' | 'order_valuation_desc' | 'order_valuation_asc' | 'product_quantity_desc' | 'product_quantity_asc' | 'product_name_desc' | 'product_name_asc' | 'sub_status_sort_desc' | 'sub_status_sort_asc' | 'first_undeliverable_at_desc' | 'first_undeliverable_at_asc' | 'customer_sort_desc' | 'customer_sort_asc' | 'estimate_delivery_date_desc' | 'estimate_delivery_date_asc' | 'order_source_desc' | 'order_source_asc'
Example:inserted_at_desc

Orders sequence

fields[]string[]

Response fields

partner_id[]integer[]

Shipping partner ID on Pancake system

shop_partner_accountinteger

Filter by shipping account ID connected to the shop

customer_idstring

Customer ID

string[]

Order sources. Format: [[order_source_id, account_id], ...] Example: [["-1", "314"], ["-3"]]

is_filter_exclude_sourceboolean

Exclude order source

ad_ids[]string[]

Advertising IDs

project_idsinteger

Project ID

extra_fields[]string[]

Extra fields

Response

Success

page_numberinteger

Page number

page_sizeinteger

Page size

successboolean

Success status

total_entriesinteger

Total entries

total_pagesinteger

Total pages

Example response

{
  "data": [
    {
      "reports_by_phone": {
        "+639175706297": {
          "order_fail": 29,
          "order_success": 20,
          "warning": 0
        }
      },
      "prepaid_by_point": {
        "money": 15000,
        "point": 15
      },
      "additional_info": {
        "delivery_deadline": "2026-06-03T10:00:00"
      },
      "customer_referral_code": {
        "active": "true",
        "customer_id": "09bb9399-45f3-4897-a53a-85dde2f886fe",
        "discount": "10",
        "format": "{PHONE_NUMBER}",
        "free_products_priced_between_approx": {
          "active": "true",
          "operator": "GreaterOrEqual",
          "price": "150000"
        },
        "is_percent": "true",
        "only_customers_with_level_will_have_referral_code": "true",
        "referral_code": "982843759",
        "reward_points_for_old_customers": {
          "active": "true",
          "money": "10000",
          "point": "1"
        },
        "shop_customer_id": "f8160a4c-dfa7-4ee8-b540-d245755ea1f1"
      }
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.