order_info

Order info in the order.

Properties

Type

Description

cancelable

boolean

Returns true if the order was cancelled. Returns false if not.

checkout_url

string

The relative checkout URL of the order.

create_at

string

The date and time when the order was created.

create_time

string

The date and time when the order was created. Same as the create_at.

code_discount_total

string

The total amount of the discount code.

currency_code

string

The currency code of the order.

customer_note

string

The customer note of the order.

discount_applications

an array of discount_application

The discount applications for the order.

discount_code

string

The discount code of the order.

discount_total

string

The discount total amount of the order.

final_total

string

The final total of the order.

financial_status

string from a set of values, refer to financial_status values

The order's financial status.

gift_card_total

string

The total amount of the gift card applied to the order.

fulfillment_status

string from a set of values, refer to fulfillment_status values

The fulfillment status of the order.

id

string

The id of the order.

line_item_discount_total

string

The discount total amount of the line item's order.

main_currency_prices

The main currency prices of the order.

note

string

The note of the order.

order_no

string

The order number of the order.

order_url

string

The relative URL of the order.

paid_total

string

The total amount paid for the order.

payment_due

string

The total amount unpaid for the order.

payment_progress

number

The 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_status

string from a set of values, refer to post_sale_status values

The post-sale status of the order.

product_tax_included

boolean

Returns true if the product includes tax. Returns false if not.

real_paid_total

string

The actual amount paid for the order.

refer_info

The refer info of the order.

shipping_address_editable

boolean

Returns true if the shipping address is editable. Returns false if not.

shipping_tax_total

string

The total shipping taxes are applied to the order.

shipping_tax_type

number

The type of shipping tax for the order.

shipping_total

string

The shipping price of the order.

status

string from a set of values, refer to status values

The status of the order.

sub_total

string

The sum of the prices of the subtotal line items, before any line item or cart discounts have been applied.

tax_total

string

The total amount of taxes applied to the order.

total

string

The total price of the order.

total_tip_received

string

The total tip of the order.

updated_at

string

The 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
}