---
title: "Get a business order"
method: GET
path: "/v3/orders/{id}"
tags: ["Orders"]
---

# Get a business order

`GET /v3/orders/{id}`

Requires the `order:read` scope. Retrieve detailed information about a specific order.

## Response `200`

Order details

- Order
  - `gross_revenue_for_dropshipper` string, decimal — Gross revenue for dropshipper after discounts
  - `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
  - `cogs` string, decimal — Cost of goods sold for the order
  - `dropshipper_name` string, nullable — Name of the dropshipper
  - `transferproof_url` string, nullable — Transfer proof URL
  - `scalev_fee` string, decimal — Scalev fee for the order
  - `shipment_status_history` object[]
    - `description` string — Description of the status update
    - `status` string — Current status of the shipment
    - `timestamp` string, date-time — Timestamp of the status update
    - `timestamp_source` string — Source of the timestamp
  - `discount_code_code` string, nullable — Discount code used in the order
  - `ready_time` string, date-time, nullable
  - `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
  - `payment_fee_rate` string, decimal — Payment fee rate applied to the order
  - `pg_paid_info` object, nullable — Payment gateway paid info
  - `transfer_time` string, date-time, nullable
  - `dropshipper_phone` string, nullable — Phone number of the dropshipper
  - `shipping_cost` string, decimal — Shipping cost for the order
  - `product_price` string, decimal — Total product price before discounts
  - `total_quantity` integer — Total quantity of items in the order
  - `net_revenue` string, decimal — Net revenue after all discounts and fees
  - `bundle_price_options` object, nullable — Bundle price options for 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
  - `variants` object, nullable — Variants of the order
  - `chat_message` string — Chat message associated with the order
  - `handler_phone` string, nullable — Handler phone number
  - `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
  - `order_emails` object[] — Order emails associated with the order
    - `from` string — Sender email address
    - `id` integer — Order email ID
    - `inserted_at` string, date-time — Email creation timestamp
    - `message_id` string — Message ID of the email
    - `order_id` string, uuid — Canonical UUIDv7 order primary key returned by the partitioned orders table.
    - `status` string — Email status
    - `status_history` object[]
      - `status` string — Email status
      - `timestamp` string, date-time — Timestamp of the status change
    - `subject` string — Email subject
    - `to` string — Recipient email address
    - `type` string — Type of the email
    - `updated_at` string, date-time — Last update timestamp of the email
  - `order_id` string — Order ID in string format
  - `product_discount` string, decimal — Total product discount applied
  - `last_updated_by` 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
  - `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
  - `courier` integer, nullable — Courier ID for the order
  - `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`.
  - `in_process_time` string, date-time, nullable
  - `pg_reference_id` string, nullable — Payment gateway reference ID
  - `weight_bump` string, decimal — Weight bump added to the order
  - `follow_up_chat_type` string, nullable — Type of follow-up chat for the order
  - `awb_status` 'unavailable' | 'pending' | 'waiting' | 'failed' | 'created' | 'canceled' — Order AWB status
  - `platform` string — Platform of the order
  - `follow_up_chats` object[]
    - `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 this order a Kwai purchase
  - `shipping_discount` string, decimal — Shipping discount applied to the order
  - `conflict_time` string, date-time, nullable
  - `paid_time` string, date-time, nullable
  - `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 repeat order
  - `tiktok_pixel_ids` string[] — TikTok pixel IDs associated with the order
  - `fb_pixel_ids` string[] — Facebook pixel IDs associated with the order
  - `id` string, uuid — Canonical UUIDv7 order primary key returned by the partitioned orders table.
  - `unpaid_time` string, date-time, nullable
  - `is_purchase_tiktok` boolean — Is this order a TikTok purchase
  - `orderlines` object[]
    - `cogs` number, float — Cost of Goods Sold for this order line
    - `variant_reseller_price_bt` number, float — Reseller price of the variant minus tax
    - `inserted_at` string, date-time — Timestamp when the order line was created
    - `product_price` number, float — Price of the product before discounts
    - `variant_price_bt` number, float — Price of the variant minus tax
    - `variant_cogs` number, float — COGS of the variant
    - `is_inventory` boolean — Is this order line related to inventory?
    - `discount` number, float — Discount amount applied
    - `product_business` integer — Business ID of the product
    - `product_name` string — Name of the product
    - `variant_reseller_price` number, float — Reseller price of the variant
    - `variant_sku` string — SKU of the variant
    - `item_type` 'physical' | 'digital' | 'course' | 'license' | 'subscription' — Type of the product item
    - `discount_bt` number, float — Discount amount minus tax
    - `pricing_type` 'one_time' | 'recurring' — Type of the product pricing
    - `variant_option1_value` string — Value of option 1 for the variant
    - `id` string, uuid — Canonical UUIDv7 order line primary key returned by the partitioned orderlines table.
    - `cogs_bt` number, float — COGS for this order line minus tax
    - `discount_rate` number, float — Discount rate applied to this order line
    - `currency` 'IDR' — The currency code for the subscription item price.
    - `quantity` integer — Quantity of the item
    - `variant_price` number, float — Price of the variant
    - `weight` number, float — Weight of the product
    - `discount_code_discount` number, float — Discount from a discount code
    - `variant` integer — Variant ID
    - `variant_cogs_bt` number, float — COGS of the varian minus tax
    - `variant_option2_value` string — Value of option 2 for the variant
    - `reseller_product_price_bt` number, float — Reseller price of the product minus tax
    - `interval_count` integer — Count of intervals for recurring pricing
    - `discount_code_discount_bt` number, float — Discount from a discount code minus tax
    - `tax_rate` number, float — Tax rate applied to this order line
    - `product_price_bt` number, float — Price of the product before discounts minus tax
    - `reseller_product_price` number, float — Reseller price of the product
    - `variant_option3_value` string — Value of option 3 for the variant
    - `interval` 'day' | 'week' | 'month' | 'year' — Unit of the period
  - `shipment_status` string, nullable — Current shipment status of the order
  - `kwai_pixel_ids` string[] — Kwai pixel IDs associated with the order
  - `cogs_bt` string, decimal — Cost of goods sold for the order minus tax
  - `payment_fee` string, decimal — Payment fee for the order
  - `channel_name` string, nullable — Channel name of the order
  - `discount_rate` string, decimal — Discount rate applied to the order
  - `final_variants` object, nullable — Final variants of the order after bundle options
  - `other_income_name` string, nullable — Name of other income source
  - `gross_revenue` string, decimal — Gross revenue of the order
  - `tags` string[] — Tags associated with the order
  - `discount_code_id` integer, nullable — Discount code ID
  - `other_income` string, decimal — Other income amount
  - `payment_link_income` string, decimal — Additional E-Payment Link amount paid by the customer
  - `status_history` object[]
    - `by` string, nullable — Who changed the status
    - `status` 'draft' | 'pending' | 'confirmed' | 'in_process' | 'ready' | 'shipped' | 'completed' | 'canceled' | 'rts' | 'closed' — Order status
    - `time` string, date-time
  - `total_weight` string, decimal — Total weight of the order including weight bump
  - `is_probably_spam` boolean — Is probably spam
  - `external_id` string — External ID of the order
  - `payment_status_history` object[]
    - `by` string, nullable — Who changed the status
    - `status` 'draft' | 'pending' | 'confirmed' | 'in_process' | 'ready' | 'shipped' | 'completed' | 'canceled' | 'rts' | 'closed' — Order status
    - `time` string, date-time
  - `discount_code_discount` string, decimal — Discount code discount amount
  - `product_discount_bt` string, decimal — Total product discount applied minus tax
  - `store` object
    - `is_unique_code` boolean — Is unique code required for orders?
    - `is_postal_code` boolean — Is postal code required for orders?
    - `is_discount_editable` boolean — Is discount editable?
    - `store_method_other_incomes` object[] — Other incomes for store methods
      - `amount` number, float — Amount of other income
      - `payment_method` string, required — Payment Method
      - `percentage` number, float — Percentage of other income
      - `type` 'fixed' | 'percentage', required — Type of amount (fixed or percentage)
    - `store_courier_other_incomes` object[] — Other incomes for store couriers
      - `amount` number, float — Amount of other income
      - `courier_id` integer, required — Courier ID
      - `percentage` number, float — Percentage of other income
      - `type` 'fixed' | 'percentage', required — Type of other income
    - `dynamic_other_income_cod_default_percentage` number, float — Default percentage for dynamic COD income
    - `dynamic_other_income_epayment_type` 'fixed' | 'percentage' — Type of amount (fixed or percentage)
    - `chatbot_system_prompt` string — Custom system prompt appended to chatbot prompt for this store
    - `dynamic_other_income_cod_default_amount` number, float — Default amount for dynamic COD income
    - `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
    - `uuid` string — UUID of the store
    - `non_cod_purchase_triggers` string[] — Non-COD purchase triggers
    - `is_dropshipping_allowed` boolean — Is dropshipping allowed in this store?
    - `cod_purchase_triggers` string[] — COD purchase triggers
    - `is_use_waba` boolean — Is WABA integration enabled?
    - `postal_code_requirement` 'autofill' | 'manual' — Postal code requirement options
    - `name` string — Name of the store
    - `id` integer — Store ID
    - `is_moota_enabled` boolean — Is Moota integration enabled for this store?
    - `unique_id` string — Unique identifier for the store
    - `other_income_name` string — Name of the other income
    - `auto_expire_days` integer — Days until auto-expire
    - `max_unique_code_amount` integer — Maximum amount for unique code orders
    - `is_auto_expire` boolean — Is auto-expire enabled?
    - `dynamic_other_income_epayment_default_amount` number, float — Default amount for dynamic e-payment income
    - `is_transferproof_required` boolean — Is transfer proof required for orders in this store?
    - `fixed_auto_other_income` boolean — Is fixed auto other income enabled?
    - `auto_other_income` boolean — Is auto other income enabled?
    - `capi_purchase_value_type` 'gross_revenue' | 'net_revenue' | 'adj_gross_revenue' — Type of CAPI purchase value
    - `is_active` boolean — Is the store active?
    - `dynamic_other_income_epayment_default_percentage` number, float — Default percentage for dynamic e-payment income
    - `dynamic_other_income_cod_type` 'fixed' | 'percentage' — Type of amount (fixed or percentage)
  - `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`.
  - `other_income_bt` string, decimal — Other income amount minus tax
  - `payment_link_income_bt` string, decimal — Additional E-Payment Link amount before tax
  - `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 — Who marked as spam
  - `net_payment_revenue` string, decimal — Net payment revenue after fees
  - `rts_time` string, date-time, nullable
  - `min_payment_fee` string, decimal — Minimum payment fee applied to the order
  - `analytics_purchases` object[] — Analytics purchases associated with the order
    - `id` integer — Analytics Purchase ID
    - `inserted_at` string, date-time — Timestamp when the analytics purchase was created
    - `order_id` string, uuid — Canonical UUIDv7 order primary key returned by the partitioned orders table.
    - `payload` object — Payload data of the analytics purchase
    - `pixel_id` string — Pixel ID associated with the purchase
    - `platform` string — Platform of the analytics purchase
    - `response` object — Response data from the analytics purchase
    - `updated_at` string, date-time — Timestamp when the analytics purchase was last updated
  - `is_from_form` boolean — Is from form submission
  - `secret_slug` string — Secret slug of 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, nullable — Untrusted agent or app attribution metadata
  - `shipping_fee` string, decimal — Shipping fee charged for the order
  - `tax_rate` number, float, nullable — Tax rate applied to the order
  - `draft_time` string, date-time, nullable
  - `last_updated_at` string, date-time — Last updated timestamp of the order
  - `courier_additional_info` string, nullable — Additional information for the courier
  - `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
  - `product_price_bt` string, decimal — Total product price before discounts minus tax
  - `is_purchase_fb` boolean — Is this order a Facebook purchase
  - `product_weight` string, decimal — Total weight of products in the order
  - `completed_time` string, date-time, nullable
  - `utm_source` string, nullable — UTM source of the order
  - `payment_account_holder` string, nullable — Payment account holder name
  - `ip` string, nullable — IP address of the customer who placed the order
  - `shipment_receipt` string, nullable — Shipment receipt URL for the order
  - `message_history` object[] — Message history associated with the order
    - `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, nullable — Metadata associated with the order
  - `rtsproof_url` string, nullable — RTS proof URL for the order
  - `discount_code_applied_to` string, nullable — What the discount code was applied to
  - `shipped_time` string, date-time, nullable
  - `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, nullable
  - `notes` string, nullable — Notes or comments for 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` string, decimal — Unique code discount applied to the order
  - `shipping_fee_discount` string, decimal — Shipping fee discount applied to the order

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found

---

[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)