SCscalev
Orders

List business orders

Changed on

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.

get/v3/orders

Request

  • Base URL
    https://api.scalev.com
  • URL
    https://api.scalev.com/v3/orders
  • Auth
    • HTTP bearer
    • or API key in header authorization

Query parameters

page_sizeinteger
Example:25

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

next_cursorstring

Opaque cursor for the next page.

previous_cursorstring

Opaque cursor for the previous page.

searchstring

Search term for the selected search_field. Defaults to order ID search when search_field is omitted or unsupported.

search_field'order_id' | 'shipment_receipt' | 'external_id' | 'pg_reference_id' | 'gross_revenue' | 'customer_name' | 'customer_email' | 'customer_phone'

Field used by search. Defaults to order_id when omitted or unsupported.

is_probably_spam'true' | 'false'

Filter spam orders

business_role'retailer' | 'fulfillment_provider'

Filter by business role

draft_time_untilstring datetime

Filter orders by draft time until (ISO 8601 format)

confirmed_time_sincestring datetime

Filter orders by confirmed time since (ISO 8601 format)

confirmed_time_untilstring datetime

Filter orders by confirmed time until (ISO 8601 format)

shipped_time_sincestring datetime

Filter orders by shipped time since (ISO 8601 format)

shipped_time_untilstring datetime

Filter orders by shipped time until (ISO 8601 format)

completed_time_sincestring datetime

Filter orders by completed time since (ISO 8601 format)

completed_time_untilstring datetime

Filter orders by completed time until (ISO 8601 format)

is_from_form'true' | 'false'

Filter orders created from a form

is_repeat'true' | 'false'

Filter repeat orders

tagsstring

Comma-separated list of tags to filter orders

product_idstring

Filter orders containing a specific product ID

is_transferproof_exist'true' | 'false'

Filter orders with transfer proof

order_idstring

Filter orders by specific order ID

awb_ca_status'unavailable' | 'pending' | 'waiting' | 'failed' | 'created' | 'canceled'

Filter orders by AWB status

status'draft' | 'pending' | 'confirmed' | 'in_process' | 'ready' | 'canceled' | 'shipped' | 'shipped_rts' | 'completed' | 'rts' | 'closed'

Filter orders by status

payment_status'paid' | 'unpaid' | 'conflict' | 'settled'

Filter orders by payment status

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'

Filter orders by payment method

shipment_statusstring

Filter orders by shipment status

business_idstring

Filter orders by business ID

store_idstring

Filter orders by store ID

warehouse_idstring

Filter orders by warehouse ID

courier_idstring

Filter orders by courier ID

handler_idstring

Filter orders by handler ID

advertiser_idstring

Filter orders by advertiser ID

platform'scalev' | 'tiktokshop' | 'tokopedia' | 'shopee' | 'lazada' | 'blibli' | 'bukalapak' | 'orderonline' | 'berdu'

Filter orders by platform

financial_entity_idstring

Filter orders by financial entity ID

page_idstring

Filter orders by page ID

external_idstring

Filter orders by external ID

affiliate_business_idinteger

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

utm_sourcestring

Filter orders by UTM source

columnsstring

Comma-separated list of columns to include. Available columns: secret_slug, public_order_url, payment_url, 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, 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

is_paginatedtrue required
has_nextboolean
has_previousboolean
next_cursorstring nullable
previous_cursorstring nullable
page_sizeinteger

Example response

{
  "is_paginated": true,
  "page_size": 25
}

Changes

  • b4add50bab84Revision changes
    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

  • 251b881b98ebRevision changes
    • breaking

      removed the enum value indomaret from the query request parameter payment_method

    • breaking

      removed the enum value va from the query request parameter payment_method

    • warning

      removed the optional property // from the response with the status

    • warning

      added the new payment_link enum value to the // response property for the response status

    • warning

      added the new va_artajasa enum value to the // response property for the response status

    • warning

      added the new va_artha_graha enum value to the // response property for the response status

    • warning

      added the new va_bca enum value to the // response property for the response status

    • warning

      added the new va_bjb enum value to the // response property for the response status

    • warning

      added the new va_bnc enum value to the // response property for the response status

    • warning

      added the new va_bni enum value to the // response property for the response status

    • warning

      added the new va_bri enum value to the // response property for the response status

    • warning

      added the new va_bsi enum value to the // response property for the response status

    • warning

      added the new va_btn enum value to the // response property for the response status

    • warning

      added the new va_cimb enum value to the // response property for the response status

    • warning

      added the new va_danamon enum value to the // response property for the response status

    • warning

      added the new va_mandiri enum value to the // response property for the response status

    • warning

      added the new va_maybank enum value to the // response property for the response status

    • warning

      added the new va_muamalat enum value to the // response property for the response status

    • warning

      added the new va_ocbc enum value to the // response property for the response status

    • warning

      added the new va_permata enum value to the // response property for the response status

    • warning

      added the new va_sahabat_sampoerna enum value to the // response property for the response status

    • info

      added the new enum value payment_link to the query request parameter payment_method

    • info

      added the new enum value va_artajasa to the query request parameter payment_method

    • info

      added the new enum value va_artha_graha to the query request parameter payment_method

    • info

      added the new enum value va_bca to the query request parameter payment_method

    • info

      added the new enum value va_bjb to the query request parameter payment_method

    • info

      added the new enum value va_bnc to the query request parameter payment_method

    • info

      added the new enum value va_bni to the query request parameter payment_method

    • info

      added the new enum value va_bri to the query request parameter payment_method

    • info

      added the new enum value va_bsi to the query request parameter payment_method

    • info

      added the new enum value va_btn to the query request parameter payment_method

    • info

      added the new enum value va_cimb to the query request parameter payment_method

    • info

      added the new enum value va_danamon to the query request parameter payment_method

    • info

      added the new enum value va_mandiri to the query request parameter payment_method

    • info

      added the new enum value va_maybank to the query request parameter payment_method

    • info

      added the new enum value va_muamalat to the query request parameter payment_method

    • info

      added the new enum value va_ocbc to the query request parameter payment_method

    • info

      added the new enum value va_permata to the query request parameter payment_method

    • info

      added the new enum value va_sahabat_sampoerna to the query request parameter payment_method

    • info

      added the optional property // to the response with the status

    • info

      removed the indomaret enum value from the // response property for the response status

    • info

      removed the va enum value from the // response property for the response status