---
title: "List business orders"
method: GET
path: "/v3/orders"
tags: ["Orders"]
---

# List business orders

`GET /v3/orders`

Requires the `order:list` scope. Retrieves a paginated list of orders with optional filtering. The data is sorted by created_at in descending order and cannot be changed. Uses cursor-based pagination with default page size of 25 and maximum of 25.

## Query parameters

- `page_size` integer
- `next_cursor` string
- `previous_cursor` string
- `search` string
- `search_field` 'order_id' | 'shipment_receipt' | 'external_id' | 'pg_reference_id' | 'gross_revenue' | 'customer_name' | 'customer_email' | 'customer_phone'
- `is_probably_spam` 'true' | 'false'
- `business_role` 'retailer' | 'fulfillment_provider'
- `draft_time_until` string, datetime
- `confirmed_time_since` string, datetime
- `confirmed_time_until` string, datetime
- `shipped_time_since` string, datetime
- `shipped_time_until` string, datetime
- `completed_time_since` string, datetime
- `completed_time_until` string, datetime
- `is_from_form` 'true' | 'false'
- `is_repeat` 'true' | 'false'
- `tags` string
- `product_id` string
- `is_transferproof_exist` 'true' | 'false'
- `order_id` string
- `awb_ca_status` 'unavailable' | 'pending' | 'waiting' | 'failed' | 'created' | 'canceled'
- `status` 'draft' | 'pending' | 'confirmed' | 'in_process' | 'ready' | 'canceled' | 'shipped' | 'shipped_rts' | 'completed' | 'rts' | 'closed'
- `payment_status` 'paid' | 'unpaid' | 'conflict' | 'settled'
- `payment_method` 'va_bca' | 'va_bni' | 'va_bri' | 'va_mandiri' | 'va_permata' | 'va_cimb' | 'va_bsi' | 'va_maybank' | 'va_bnc' | 'va_danamon' | 'va_artha_graha' | 'va_muamalat' | 'va_btn' | 'va_ocbc' | 'va_bjb' | 'va_sahabat_sampoerna' | 'va_artajasa' | 'qris' | 'card' | 'invoice' | 'payment_link' | 'alfamart' | 'ovo' | 'dana' | 'shopeepay' | 'linkaja' | 'gopay' | 'no_payment' | 'bank_transfer' | 'marketplace' | 'cod'
- `shipment_status` string
- `business_id` string
- `store_id` string
- `warehouse_id` string
- `courier_id` string
- `handler_id` string
- `advertiser_id` string
- `platform` 'scalev' | 'tiktokshop' | 'tokopedia' | 'shopee' | 'lazada' | 'blibli' | 'bukalapak' | 'orderonline' | 'berdu'
- `financial_entity_id` string
- `page_id` string
- `external_id` string
- `affiliate_business_id` integer
- `utm_source` string
- `columns` string

## Response `200`

Orders list with pagination

- ListOrdersResponseBody — Paginated list payload for v3.
  - `data` OrderList[], required
    - `advertiser` object
      - `aff_code` string — Affiliate code of the user
      - `avatar` string, uri — URL to user avatar
      - `email` string, email — User email
      - `fullname` string — User full name
      - `id` integer — User ID
      - `phone` string — User phone number
    - `dropshipper_name` string, nullable — Dropshipper name
    - `transferproof_url` string, nullable — Transfer proof URL
    - `scalev_fee` number — Scalev fee associated with the order
    - `discount_code_code` string, nullable — Discount code used in the order
    - `warehouse` object
      - `business` object
        - `account_holder` string — Name of the account holder
        - `email` string, email — Email address of the business
        - `id` integer — Business ID
        - `is_banned` boolean — Is the business banned?
        - `logo` string, uri — URL to the business logo
        - `unique_id` string — Unique identifier for the business
        - `username` string — Username of the business
      - `contact_name` string — Contact name at the warehouse
      - `contact_phone` string — Contact phone number at the warehouse
      - `id` integer — Warehouse ID
      - `name` string — Name of the warehouse
    - `transfer_time` string, date-time, nullable — Transfer timestamp of the order
    - `dropshipper_phone` string, nullable — Dropshipper phone number
    - `shipping_cost` number — Shipping cost associated with the order
    - `product_price` number — Total product price before discounts
    - `net_revenue` number — Net revenue from the order
    - `customer` object
      - `confirmed_at` string, date-time — Confirmation timestamp
      - `created_at` string, date-time — Creation timestamp
      - `email` string, email — Customer email
      - `id` integer — Customer ID
      - `last_updated_at` string, date-time — Last update timestamp
      - `name` string — Customer name
      - `phone` string — Customer phone number
      - `status` string — Customer status
    - `handler_phone` string, nullable — Handler phone number
    - `order_id` string — Order ID in string format
    - `product_discount` number — Total product discount applied to the order
    - `handler` object
      - `aff_code` string — Affiliate code of the user
      - `avatar` string, uri — URL to user avatar
      - `email` string, email — User email
      - `fullname` string — User full name
      - `id` integer — User ID
      - `phone` string — User phone number
    - `payment_account_number` string, nullable — Payment account number
    - `payment_method` 'va_bca' | 'va_bni' | 'va_bri' | 'va_mandiri' | 'va_permata' | 'va_cimb' | 'va_bsi' | 'va_maybank' | 'va_bnc' | 'va_danamon' | 'va_artha_graha' | 'va_muamalat' | 'va_btn' | 'va_ocbc' | 'va_bjb' | 'va_sahabat_sampoerna' | 'va_artajasa' | 'qris' | 'card' | 'invoice' | 'payment_link' | 'alfamart' | 'ovo' | 'dana' | 'shopeepay' | 'linkaja' | 'gopay' | 'no_payment' | 'bank_transfer' | 'marketplace' | 'cod' — Order payment method
    - `origin_address` object
      - `address` string — Full address of the warehouse
      - `city` string — City of the warehouse address
      - `id` integer — Warehouse Address ID
      - `location` integer — Location ID for the address
      - `location_id` integer — Location ID for the address
      - `postal_code` string — Postal code of the warehouse address
      - `province` string — Province of the warehouse address
      - `subdistrict` string — Subdistrict of the warehouse address
      - `warehouse` integer — ID of the associated warehouse
    - `epayment_provider` string, nullable — E-payment provider. `xendit` is the current/managed Xendit provider; `xendit_legacy` is the owned legacy Xendit provider. Other possible values include `duitku`, `midtrans`, `durianpay`, and `singapay`.
    - `pg_reference_id` string, nullable — Payment gateway reference ID
    - `follow_up_chat_type` 'product' | 'order' — Type of follow up chat
    - `awb_status` 'unavailable' | 'pending' | 'waiting' | 'failed' | 'created' | 'canceled' — Order AWB status
    - `platform` string — Platform where the order was placed
    - `follow_up_chats` object[] — Follow up chats associated with the order
      - `bundle_id` integer — Bundle ID associated with the chat
      - `change_status` boolean — Change status after follow up chat
      - `hours_after` integer — Hours after which the follow up chat is triggered
      - `id` integer — Follow Up Chat ID
      - `image` string, uri — Image URL for the follow up chat
      - `is_default` boolean — Is this a default follow up chat?
      - `name` string — Name of the follow up chat
      - `product_id` integer — Product ID associated with the chat
      - `provider` string — Provider of the follow up chat service
      - `store_id` integer — Store ID associated with the chat
      - `trigger` string — Trigger condition for the follow up chat
    - `is_purchase_kwai` boolean — Is the order a Kwai purchase
    - `shipping_discount` number — Shipping discount applied to the order
    - `confirmed_time` string, date-time, nullable
    - `canceled_time` string, date-time, nullable
    - `status` 'draft' | 'pending' | 'confirmed' | 'in_process' | 'ready' | 'shipped' | 'completed' | 'canceled' | 'rts' | 'closed' — Order status
    - `is_dropshipping` boolean — Is the order a dropshipping order
    - `payment_account_id` integer, nullable — Payment account ID
    - `is_repeat` boolean — Is the order a repeat order
    - `tiktok_pixel_ids` string[]
    - `fb_pixel_ids` string[]
    - `id` string, uuid — Canonical UUIDv7 order primary key returned by the partitioned orders table.
    - `is_purchase_tiktok` boolean — Is the order a TikTok purchase
    - `shipment_status` string, nullable — Current shipment status of the order
    - `kwai_pixel_ids` string[]
    - `payment_fee` number — Payment fee associated with the order
    - `channel_name` string, nullable — Channel name
    - `final_variants` object
    - `other_income_name` string, nullable — Name of the other income
    - `gross_revenue` string, decimal — Gross revenue from the order
    - `tags` object[] — Tags associated with the order
      - `id` integer — Tag ID
      - `name` string — Tag Name
    - `other_income` number — Other income associated with the order
    - `payment_link_income` number — Additional E-Payment Link amount paid by the customer
    - `total_weight` number — Total weight of the order
    - `is_probably_spam` boolean — Is the order probably spam
    - `external_id` string, nullable — External ID for the order
    - `discount_code_discount` string, decimal — Discount amount from the discount code
    - `store` object
      - `business` object
        - `account_holder` string — Name of the account holder
        - `email` string, email — Email address of the business
        - `id` integer — Business ID
        - `is_banned` boolean — Is the business banned?
        - `logo` string, uri — URL to the business logo
        - `unique_id` string — Unique identifier for the business
        - `username` string — Username of the business
      - `id` integer — Store ID
      - `name` string — Name of the store
      - `unique_id` string — Unique identifier for the store
      - `uuid` string — UUID of the store
    - `pg_payment_info` object, nullable — Payment gateway payment info. SingaPay payments use normalized keys such as `payment_url`, `deeplink_url`, `qr_string`, `qr_image_url`, `va_number`, and `va_name`.
    - `courier_service` object
      - `code` string — Code for the courier service
      - `code_co` string — Code for CO courier service
      - `code_ka` string — Code for KA courier service
      - `code_lincah` string — Code for Lincah courier service
      - `code_mengantar` string — Code for Mengantar courier service
      - `code_ro` string — Code for RO courier service
      - `courier` object
        - `code` string — Courier code
        - `code_ka` string — Courier code in Georgian
        - `code_lincah` string — Courier code in Lincah
        - `code_mengantar` string — Courier code for Mengantar
        - `code_ro` string — Courier code in Romanian
        - `courier_type` 'delivery' | 'pickup' — Type of the courier
        - `id` integer — Courier ID
        - `is_pickup` boolean — Is this a pickup courier?
        - `name` string — Courier name
      - `id` integer — Courier Service ID
      - `name` string — Name of the courier service
    - `mark_as_spam_by` string, nullable — Who marked the order as spam
    - `net_payment_revenue` string, decimal — Net payment revenue from the order
    - `rts_time` string, date-time, nullable — Ready to ship timestamp
    - `secret_slug` string, nullable — Secret slug for the order
    - `public_order_url` string, uri, nullable — Public order URL built from metadata.custom_domain_full_url and secret_slug.
    - `payment_url` string, uri, nullable — Payment URL built from public_order_url with /success appended.
    - `agent_context` object — Untrusted agent or app attribution metadata
    - `draft_time` string, date-time — Draft timestamp
    - `last_updated_at` string, date-time — Last updated timestamp of the order
    - `courier_additional_info` string, nullable — Additional courier information
    - `closed_time` string, date-time, nullable
    - `financial_entity` object
      - `code` string — Code of the financial entity
      - `duitku_code` string — Duitku code for the financial entity
      - `entity_type` string — Type of the financial entity
      - `id` integer — Financial Entity ID
      - `name` string — Name of the financial entity
      - `platform` string — Platform associated with the financial entity
      - `xendit_code` string — Xendit code for the financial entity
    - `is_purchase_fb` boolean — Is the order a Facebook purchase
    - `completed_time` string, date-time, nullable
    - `utm_source` string, nullable — UTM source for tracking
    - `payment_account_holder` string, nullable — Payment account holder name
    - `shipment_receipt` string, nullable — Shipment receipt URL
    - `message_history` object[]
      - `id` integer — ID of the Follow Up Chat
      - `is_from_bot` boolean — Is the message from bot
      - `message` string — Message content
      - `name` string — Name of the sender
      - `provider` string — Message provider
      - `recipient_name` string — Recipient name
      - `recipient_phone` string — Recipient phone number
      - `sender_name` string — Sender name
      - `sender_phone` string — Sender phone number
      - `timestamp` string, date-time — Timestamp of the message
    - `payment_status` 'unpaid' | 'paid' | 'conflict' | 'settled' — Order payment status
    - `shipment_provider_code` 'mengantar' | 'lincah' | 'ninja', nullable — Shipment provider code
    - `metadata` object — Metadata associated with the order
    - `discount_code_applied_to` string, nullable — Discount code applied to the order
    - `shipped_time` string, date-time, nullable — Shipped timestamp of the order
    - `awb_ca_status` 'unavailable' | 'pending' | 'waiting' | 'failed' | 'created' | 'canceled' — Order AWB courier aggregator status
    - `created_at` string, date-time — Order creation timestamp
    - `pending_time` string, date-time — Pending timestamp of the order
    - `notes` string, nullable — Notes associated with the order
    - `destination_address` object
      - `address` string — Full address
      - `city` string — City of the address
      - `id` integer — Order Address ID
      - `location` integer — Location ID for the address
      - `name` string — Name of the recipient
      - `phone` string — Phone number of the recipient
      - `postal_code` string — Postal code of the address
      - `province` string — Province of the address
      - `subdistrict` string — Subdistrict of the address
    - `unique_code_discount` number — Discount from unique code applied to the order
  - `is_paginated` true, required
  - `has_next` boolean
  - `has_previous` boolean
  - `next_cursor` string, nullable
  - `previous_cursor` string, nullable
  - `page_size` integer

## Other responses

- `401` — Unauthorized
- `403` — Forbidden

---

[API](https://skmtc.net/scalev/apis/nexus-commerce-api.md) · [All operations](https://skmtc.net/scalev/apis/nexus-commerce-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/scalev/nexus-commerce-api/versions/4354959d76dc/schema)