Skip to main content
GET
/
v3
/
orders
List business orders
curl --request GET \
  --url https://api.myscalev.com/v3/orders \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "advertiser": {
        "aff_code": "<string>",
        "avatar": "<string>",
        "email": "jsmith@example.com",
        "fullname": "<string>",
        "id": 123,
        "phone": "<string>"
      },
      "dropshipper_name": "<string>",
      "transferproof_url": "<string>",
      "scalev_fee": 123,
      "discount_code_code": "<string>",
      "warehouse": {
        "business": {
          "account_holder": "<string>",
          "email": "jsmith@example.com",
          "id": 123,
          "is_banned": true,
          "logo": "<string>",
          "unique_id": "<string>",
          "username": "<string>"
        },
        "contact_name": "<string>",
        "contact_phone": "<string>",
        "id": 123,
        "name": "<string>"
      },
      "transfer_time": "2023-11-07T05:31:56Z",
      "dropshipper_phone": "<string>",
      "shipping_cost": 123,
      "product_price": 123,
      "net_revenue": 123,
      "customer": {
        "confirmed_at": "2023-11-07T05:31:56Z",
        "created_at": "2023-11-07T05:31:56Z",
        "email": "jsmith@example.com",
        "id": 123,
        "last_updated_at": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "phone": "<string>",
        "status": "<string>"
      },
      "handler_phone": "<string>",
      "order_id": "<string>",
      "product_discount": 123,
      "handler": {
        "aff_code": "<string>",
        "avatar": "<string>",
        "email": "jsmith@example.com",
        "fullname": "<string>",
        "id": 123,
        "phone": "<string>"
      },
      "payment_account_number": "<string>",
      "payment_method": "va",
      "origin_address": {
        "address": "<string>",
        "city": "<string>",
        "id": 123,
        "location": 123,
        "location_id": 123,
        "postal_code": "<string>",
        "province": "<string>",
        "subdistrict": "<string>",
        "warehouse": 123
      },
      "epayment_provider": "<string>",
      "pg_reference_id": "<string>",
      "follow_up_chat_type": "product",
      "awb_status": "unavailable",
      "platform": "<string>",
      "follow_up_chats": [
        {
          "bundle_id": 123,
          "change_status": true,
          "hours_after": 123,
          "id": 123,
          "image": "<string>",
          "is_default": true,
          "name": "<string>",
          "product_id": 123,
          "provider": "<string>",
          "store_id": 123,
          "trigger": "<string>"
        }
      ],
      "is_purchase_kwai": true,
      "shipping_discount": 123,
      "confirmed_time": "2023-11-07T05:31:56Z",
      "canceled_time": "2023-11-07T05:31:56Z",
      "status": "draft",
      "is_dropshipping": true,
      "payment_account_id": 123,
      "is_repeat": true,
      "tiktok_pixel_ids": [
        "<string>"
      ],
      "fb_pixel_ids": [
        "<string>"
      ],
      "id": 123,
      "is_purchase_tiktok": true,
      "shipment_status": "<string>",
      "kwai_pixel_ids": [
        "<string>"
      ],
      "sub_payment_method": "BCA",
      "payment_fee": 123,
      "channel_name": "<string>",
      "final_variants": {},
      "other_income_name": "<string>",
      "gross_revenue": "<string>",
      "tags": [
        {
          "id": 123,
          "name": "<string>"
        }
      ],
      "other_income": 123,
      "total_weight": 123,
      "is_probably_spam": true,
      "external_id": "<string>",
      "discount_code_discount": "<string>",
      "store": {
        "business": {
          "account_holder": "<string>",
          "email": "jsmith@example.com",
          "id": 123,
          "is_banned": true,
          "logo": "<string>",
          "unique_id": "<string>",
          "username": "<string>"
        },
        "id": 123,
        "name": "<string>",
        "unique_id": "<string>",
        "uuid": "<string>"
      },
      "pg_payment_info": {},
      "courier_service": {
        "code": "<string>",
        "code_co": "<string>",
        "code_ka": "<string>",
        "code_lincah": "<string>",
        "code_mengantar": "<string>",
        "code_ro": "<string>",
        "courier": {
          "code": "<string>",
          "code_ka": "<string>",
          "code_lincah": "<string>",
          "code_mengantar": "<string>",
          "code_ro": "<string>",
          "courier_type": "delivery",
          "id": 123,
          "is_pickup": true,
          "name": "<string>"
        },
        "id": 123,
        "name": "<string>"
      },
      "mark_as_spam_by": "<string>",
      "net_payment_revenue": "<string>",
      "rts_time": "2023-11-07T05:31:56Z",
      "secret_slug": "<string>",
      "agent_context": {},
      "draft_time": "2023-11-07T05:31:56Z",
      "last_updated_at": "2023-11-07T05:31:56Z",
      "courier_additional_info": "<string>",
      "closed_time": "2023-11-07T05:31:56Z",
      "financial_entity": {
        "code": "<string>",
        "duitku_code": "<string>",
        "entity_type": "<string>",
        "id": 123,
        "name": "<string>",
        "platform": "<string>",
        "xendit_code": "<string>"
      },
      "page": {
        "id": 123,
        "is_published": true,
        "name": "<string>",
        "published_at": "2023-11-07T05:31:56Z",
        "slug": "<string>",
        "store_id": 123,
        "unique_id": "<string>"
      },
      "is_purchase_fb": true,
      "completed_time": "2023-11-07T05:31:56Z",
      "utm_source": "<string>",
      "payment_account_holder": "<string>",
      "shipment_receipt": "<string>",
      "message_history": [
        {
          "id": 123,
          "is_from_bot": true,
          "message": "<string>",
          "name": "<string>",
          "provider": "<string>",
          "recipient_name": "<string>",
          "recipient_phone": "<string>",
          "sender_name": "<string>",
          "sender_phone": "<string>",
          "timestamp": "2023-11-07T05:31:56Z"
        }
      ],
      "payment_status": "unpaid",
      "shipment_provider_code": "mengantar",
      "metadata": {},
      "discount_code_applied_to": "<string>",
      "shipped_time": "2023-11-07T05:31:56Z",
      "awb_ca_status": "unavailable",
      "created_at": "2023-11-07T05:31:56Z",
      "pending_time": "2023-11-07T05:31:56Z",
      "notes": "<string>",
      "destination_address": {
        "address": "<string>",
        "city": "<string>",
        "id": 123,
        "location": 123,
        "name": "<string>",
        "phone": "<string>",
        "postal_code": "<string>",
        "province": "<string>",
        "subdistrict": "<string>"
      },
      "unique_code_discount": 123
    }
  ],
  "is_paginated": true,
  "has_next": false,
  "last_id": 99,
  "page_size": 25
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
page_size
integer

Number of items per page (default: 25, max: 25)

Required range: x <= 25
Example:

25

​
last_id
integer

Last order ID for cursor-based pagination

​
search
string

Search term to filter orders by order ID, customer name, email, or phone number

​
is_probably_spam
enum<string>

Filter spam orders

Available options:
true,
false
​
business_role
enum<string>

Filter by business role

Available options:
retailer,
fulfillment_provider
​
draft_time_until
string<datetime>

Filter orders by draft time until (ISO 8601 format)

​
confirmed_time_since
string<datetime>

Filter orders by confirmed time since (ISO 8601 format)

​
confirmed_time_until
string<datetime>

Filter orders by confirmed time until (ISO 8601 format)

​
shipped_time_since
string<datetime>

Filter orders by shipped time since (ISO 8601 format)

​
shipped_time_until
string<datetime>

Filter orders by shipped time until (ISO 8601 format)

​
completed_time_since
string<datetime>

Filter orders by completed time since (ISO 8601 format)

​
completed_time_until
string<datetime>

Filter orders by completed time until (ISO 8601 format)

​
is_from_form
enum<string>

Filter orders created from a form

Available options:
true,
false
​
is_repeat
enum<string>

Filter repeat orders

Available options:
true,
false
​
tags
string

Comma-separated list of tags to filter orders

​
product_id
string

Filter orders containing a specific product ID

​
is_transferproof_exist
enum<string>

Filter orders with transfer proof

Available options:
true,
false
​
order_id
string

Filter orders by specific order ID

​
awb_ca_status
enum<string>

Filter orders by AWB status

Available options:
unavailable,
pending,
waiting,
failed,
created,
canceled
​
status
enum<string>

Filter orders by status

Available options:
draft,
pending,
confirmed,
in_process,
ready,
canceled,
shipped,
shipped_rts,
completed,
rts,
closed
​
payment_status
enum<string>

Filter orders by payment status

Available options:
paid,
unpaid,
conflict,
settled
​
payment_method
enum<string>

Filter orders by payment method

Available options:
no_payment,
bank_transfer,
marketplace,
va,
qris,
ewallet,
cod,
card,
gopay,
invoice,
alfamart,
ovo,
dana,
shopeepay,
linkaja
​
shipment_status
string

Filter orders by shipment status

​
business_id
string

Filter orders by business ID

​
store_id
string

Filter orders by store ID

​
warehouse_id
string

Filter orders by warehouse ID

​
courier_id
string

Filter orders by courier ID

​
handler_id
string

Filter orders by handler ID

​
advertiser_id
string

Filter orders by advertiser ID

​
platform
enum<string>

Filter orders by platform

Available options:
scalev,
tiktokshop,
tokopedia,
shopee,
lazada,
blibli,
bukalapak,
orderonline,
berdu
​
financial_entity_id
string

Filter orders by financial entity ID

​
page_id
string

Filter orders by page ID

​
external_id
string

Filter orders by external ID

​
affiliate_business_id
integer

Filter orders by affiliate business ID (for affiliates to see orders they brought)

​
utm_source
string

Filter orders by UTM source

​
columns
string

Comma-separated list of columns to include. Available columns: secret_slug, final_variants, store, origin_address, address_location, handler_phone, order_id, destination_address, quantity, product_price, total_weight, courier_service, shipping_cost, payment_method, gross_revenue, shipment_receipt, courier_additional_info, payment_status, status, customer, draft_time, orderlines, is_dropshipping, dropshipper_name, dropshipper_phone, unique_code_discount, tags, awb_status, awb_ca_status, follow_up_chats, follow_up_chat_type, message_history, metadata, notes, courier_aggregator_code, shipment_account, payment_account, financial_entity, payment_account_holder, payment_account_number, transferproof_url, transfer_time, product_discount, shipping_discount, other_income, other_income_name, shipment_status, is_repeat, platform, external_id, is_purchase_fb, is_purchase_tiktok, is_purchase_kwai, fb_pixel_ids, tiktok_pixel_ids, kwai_pixel_ids, pending_time, confirmed_time, shipped_time, completed_time, rts_time, canceled_time, closed_time, warehouse, page, channel_name, handler, advertiser, pg_payment_info, sub_payment_method, epayment_provider, invoice_url, pg_reference_id, net_revenue, payment_fee, scalev_fee, net_payment_revenue, discount_code_discount, discount_code_code, discount_code_applied_to, utm_source

Response

Orders list with pagination

Paginated list payload for v3.

​
data
OrderList · object[]
required
​
is_paginated
enum<boolean>
required
Available options:
true
Example:

true

​
has_next
boolean
default:false
Example:

false

​
last_id
integer | null
Example:

99

​
page_size
integer
default:25
Example:

25