AppsThemesSupport

order_info

Order info in the order.

PropertiesTypeDescription
cancelablebooleanReturns true if the order was cancelled. Returns false if not.
checkout_urlstringThe relative checkout URL of the order.
create_atstringThe date and time when the order was created.
create_timestringThe date and time when the order was created. Same as the create_at.
code_discount_totalstringThe total amount of the discount code.
currency_codestringThe currency code of the order.
customer_notestringThe customer note of the order.
discount_applicationsan array of discount_applicationThe discount applications for the order.
discount_codestringThe discount code of the order.
discount_totalstringThe discount total amount of the order.
final_totalstringThe final total of the order.
financial_statusstring from a set of values, refer to financial_status valuesThe order's financial status.
gift_card_totalstringThe total amount of the gift card applied to the order.
fulfillment_statusstring from a set of values, refer to fulfillment_status valuesThe fulfillment status of the order.
idstringThe id of the order.
line_item_discount_totalstringThe discount total amount of the line item's order.
main_currency_pricesThe main currency prices of the order.
notestringThe note of the order.
order_nostringThe order number of the order.
order_urlstringThe relative URL of the order.
paid_totalstringThe total amount paid for the order.
payment_duestringThe total amount unpaid for the order.
payment_progressnumberThe payment progress of the order.

The gift card isn't displayed when the value is 1.

It shows that the customer has paid when the value is 2.

It shows order.payment_lines when the value is 3.
post_sale_statusstring from a set of values, refer to post_sale_status valuesThe post-sale status of the order.
product_tax_includedbooleanReturns true if the product includes tax. Returns false if not.
real_paid_totalstringThe actual amount paid for the order.
refer_infoThe refer info of the order.
shipping_address_editablebooleanReturns true if the shipping address is editable. Returns false if not.
shipping_tax_totalstringThe total shipping taxes are applied to the order.
shipping_tax_typenumberThe type of shipping tax for the order.
shipping_totalstringThe shipping price of the order.
statusstring from a set of values, refer to status valuesThe status of the order.
sub_totalstringThe sum of the prices of the subtotal line items, before any line item or cart discounts have been applied.
tax_totalstringThe total amount of taxes applied to the order.
totalstringThe total price of the order.
total_tip_receivedstringThe total tip of the order.
updated_atstringThe date and time when the order was updated.

financial_status values

Possible values
waiting
paying
paid
cancelled
failed
refunding
refund_failed
refunded
partially_refunded

fulfillment_status values

Possible values
waiting
partially_shipped
shipped
partially_finished
finished
cancelled
returning
returned

post_sale_status values

Possible values
pending
processing
finished

status values

Possible values
opened
placed
cancelled
finished
{
  "code_discount_total": "0.00",
  "config": "{\"page_type\":\"three_step\"}",
  "create_time": "2023-02-23T02:09:41Z",
  "currency_code": "USD",
  "customer_note": "",
  "discount_applications": "[{\"discount_amount\":222,\"discount_id\":\"bb5ead96-3879-49b5-ae2e-9f14c22e9c50\",\"discount_type\":\"fixed_price\",\"show\":false,\"target_selection\":\"all\",\"target_type\":\"line_item\",\"title\":\"定价捆绑\",\"type\":\"automatic\",\"value_type\":\"fixed_price\"},{\"discount_amount\":20,\"discount_id\":\"53b13206-6de7-48dd-baa5-a542f5be26f5\",\"discount_type\":\"fixed_amount\",\"show\":false,\"target_selection\":\"entitled\",\"target_type\":\"line_item\",\"title\":\"满减\",\"type\":\"discount_rebate\",\"value_type\":\"fixed_amount\"}]",
  "discount_code": "",
  "discount_total": "242.00",
  "fail_code": "",
  "financial_status": "paid",
  "fulfillment_status": "partially_shipped",
  "id": "7126100318181827509",
  "line_item_discount_total": "20.00",
  "note": "",
  "order_no": "00000290",
  "post_sale_status": "",
  "refer_info": {
    "$latest_referrer": "",
    "$latest_search_keyword": "未取到值_直接打开",
    "$latest_traffic_source_type": "直接流量",
    "address_check": true,
    "client_id": "1675759325698268",
    "country": "CN",
    "customer_session": "4f08cd12-b2b5-4a06-ad5c-56fcae90d8db",
    "domain": "duck.stg.myshoplaza.com",
    "fbc": "",
    "fbp": "fb.1.1673399565778.1555746572",
    "inventory_deduction": "order_created",
    "ip": "113.89.34.69",
    "session_id": "1677112924658268",
    "source": "cart",
    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/110.0.0.0 Safari/537.36"
  },
  "shipping_address_editable": false,
  "shipping_total": "0.00",
  "status": "placed",
  "sub_total": "2796.00",
  "tax_total": "0.00",
  "total": "2554.00",
  "updated_at": "2023-02-23T02:49:51Z",
  "total_tip_received": "0.00",
  "cancelable": false,
  "create_at": "2023-02-23T02:09:41Z",
  "gift_card_total": "20.00",
  "paid_total": "2554.00",
  "payment_due": "0.00",
  "payment_progress": 3,
  "real_paid_total": "2554.00",
  "checkout_url": "/checkout/7126100318181827509",
  "order_url": "/order/7126100318181827509",
  "main_currency_prices": {
    "sub_total": "2796",
    "shipping_total": "0",
    "tax_total": "0",
    "discount_total": "242",
    "total": "2554",
    "total_tip_received": "0",
    "actual_rate": "1",
    "actual_rate_show": ""
  },
  "final_total": "2554.00",
  "order_type": 0,
  "shipping_tax_type": 0,
  "shipping_tax_total": "0.00",
  "product_tax_included": false
}

Updated 10 months ago