AppsThemesSupport

Order Properties

🔒

Requires order access scope.

Order

Order Properties

FieldsTypeDesc
idstringThe id of the order.
numberstringOrder's number
notestring
statusstringOrder status
financial_statusstringFinancial status
fulfillment_statusstringFulfillment status
email_statusstringRecovery email status: waiting, send
recovery_statusstringRecovery status：waiting, sending, recalling, failed, success
payment_methodstringPayment method
discount_codestringDiscount code
discount_applicationsstringDetails of discounts
customer_notestringCustomer notes
landing_sitestringFirst visited page
buyer_accepts_marketingboolWhether the customer accepts the marketing promotion
currencystringCurrency code
total_pricestringTotal price of the order (final price paid by the customer), numeric string, for example: "9.99"
sub_totalstringTotal price of products, numeric string, for example: "9.99"
total_discountstringDiscount price, numeric string, for example: "9.99"
total_taxstringOrder tax, numeric string, for example: "9.99"
total_shippingstringOrder logistics fee, numeric string, for example: "9.99"
code_discount_totalstringOrder discount code discount price, numeric string, for example: "9.99"
line_item_discount_totalstringProduct discount, numeric string, for example: "9.99"
gift_card_totalstringGift card discount amount, numeric string, for example: "9.99"
total_refund_pricestringTotal refund amount, numeric string, for example: "9.99"
total_refund_discountstringTotal discount refunded, numeric string, for example: "9.99"
product_tax_includedboolWhether the product include tax
additional_totalstringTotal amount of additional charges, numeric string, for example: "9.99"
addtional_pricesarray of objectAdditional charges
addtional_prices.namestringAdditional price name
addtional_prices.pricestringAdditional price
customer_deleted_atstringTime of user deletion
deleted_atstringDeletion time
placed_atstringPayment time
total_tip_receivedstring
browser_ipstringVisitor IP address
last_landing_urlstringCustomer last visited page
total_paidstringTotal payment amount
sourcestringProduct link
source_nameobjectReferrer
source_name.datastring
source_name.created_atstring
last_referrer_showobjectLast interaction source
last_referrer_show.datastring
last_referrer_show.created_atstring
shipping_lineobjectShipping plan
shipping_line.namestring
customerCustomerCustomer details
shipping_addressAddressDelivery address
billing_addressAddressBilling address
payment_linePaymentLinePayment details
line_itemsarray of LineItemList of purchased products
fulfillmentsarray of FulfillmentList of fulfillments
logistics_codestringLogistics code
refer_infostringVisit information
configOrderConfigOrder configuration information
sales_platformstringSales platform

LineItem

FieldTypeDesc
idstring
product_idstringProduct's ID
variant_idstringVaraint's ID
product_titlestringProduct title
product_handlestringProduct SEO link
variant_titlestringVariant title
quantityintegerQuantity purchased
notestring
fulfillment_statusstringFulfillment status
skustringThe SKU of the variant
weightstringProduct weight
weight_unitstringWeight unit
vendorstringVendor
product_urlstringProduct URL for customers
compare_at_pricestringCompare at price
imagestringVariant image link
pricestringPrice
totalstringTotal amount
propertiesarray of objectsProperties, corresponding to options of the variant
properties.namestringProperty name, corresponds to option name
properties.valuestringProperty value, corresponds to option value
custom_propertiesmap[string]stringCustom properties
refund_quantityintegerRefund quantity
refund_totalstringRefund total amount
taxablebooleanTaxable or not
requires_shippingbooleanRequires shipping or not
shipping_quantityintegerShipping quantity

PaymentLine

FieldTypeDesc
payment_channelstringPayment channel
payment_methodstringPayment method
transaction_nostringTransaction number
merchant_idstringMerchant ID
merchant_emailstringMerchant email
paid_totalstringTotal amount paid via this channel

OrderConfig

FieldTypeDesc
pay_typestringPayment type
product_tax_includedbooleanWhether the product includes tax
requires_shippingbooleanWhether shipping is required
checkout_business_typeintegerCheckout business type
checkout_template_typeintegerCheckout template type
market_settingMarketSettingMarket settings

MarketSetting

FieldTypeDesc
primary_market_langstringPrimary market language
market_langstringMarket language, for example: en-US
market_idstringMarket configuration ID
market_currencystringMarket currency code, for example: USD
market_countrystringMarket country, for example: US
market_currency_symbolMarketCurrencySymbolMarket currency symbol
market_base_idstringMarket base ID
market_base_currencystringMarket base currency, for example: USD
market_base_currency_symbolMarketCurrencySymbolMarket base currency symbol
primary_market_idstringPrimary market ID
primary_market_currencystringPrimary market currency code, for example: USD
primary_market_currency_symbolMarketCurrencySymbolPrimary market currency symbol
market_price_settingMarketPriceSettingMarket price settings

MarketCurrencySymbol

Field NameField TypeDescription
codestringCurrency code, for example: USD
valstringCurrency symbol, for example: $
leftstringContent displayed to the left of the number, for example: $
rightstringContent displayed to the right of the number

MarketPriceSetting

FieldFieldDesc
local_currency_enabledbooleanLocal currency enable status
custom_rate_enabledbooleanCustom rate enable status
custom_ratenumberCustom rate, primary market currency -> market base currency
ratenumberprimary market currency -> market base currency / local currency
back_ratenumbermarket base currency / local currency -> primary market currency
actual_ratenumberActual exchange rate, primary market currency -> market base currency / local currency
base_to_localintegermarket base currency -> local currency
adjustintegerPrice adjustment
price_round_enabledbooleanEnable price rounding

Order Status

Statusdesc
openedOrder successfully created
canceledCancellation of unpaid order
placedCompleted paid orders
finishedThe scenarios where the order is in the finished state:

1. All items in the order have been received
2. Order cancelled after payment
3. Full refund of order amount with all items deleted
4. Full refund of order amount with all items returned

Financial Status

StatusDesc
waitingPending payment
payingPayment Processing
authorizedAuthorized
partially_paidPartial Payment (Gift Card Used)
paidPayment Received
cancelledPayment Cancelled
failedPayment Failed
refundingRefund Processing
refund_failRefund Failed
refundedFully Refunded
partially_refundedPartial Refund

Fulfillment Status

StatusDesc
initialledInitial status, order unpaid
waitingAwaiting shipment
cancelledCancel shipment
partially_shippedPartial shipment
shippedFull shipment
partially_finishedPartial receipt
finishedFull receipt
returningReturn in progress
partially_returnedPartial return
returnedFull return

Example

{
  "order": {
    "id": "633130-00000007",
    "note": null,
    "number": "00000007",
    "financial_status": "paid",
    "status": "placed",
    "cancel_reason": null,
    "payment_method": "bogus_gateway",
    "fulfillment_status": "waiting",
    "discount_code": "HZV85Q4K",
    "discount_applications": "[{\"type\":\"discount_code\",\"subtype\":\"discount_code\",\"title\":\"test\",\"code\":\"HZV85Q4K\",\"discount_amount\":8.1,\"message\":\"The HZV85Q4K has been applied\",\"discount_message\":\"1.11914036755885642000\",\"status\":\"success\",\"discount_id\":\"eedfd5d8-0fbd-4ec6-9055-a43ea68dbec8\",\"value_type\":\"percentage\",\"target_type\":\"line_item\",\"apply_method\":\"\",\"target_selection\":\"all\",\"discount_type\":\"percentage\",\"entitled_product_list\":[],\"properties\":\"\",\"discount_text\":\"Discount Code\",\"is_free_gift\":false}]",
    "customer_note": "",
    "landing_site": "https://test-shoplazza.stg.myshoplaza.com/checkout/633130-00000001?key=e281e6f81c335487dd91cf3df34a8e",
    "buyer_accepts_marketing": true,
    "currency": "CNY",
    "total_price": "109.90",
    "total_discount": "8.10",
    "total_tax": "0.00",
    "total_shipping": "37.00",
    "sub_total": "81.00",
    "code_discount_total": "8.10",
    "line_item_discount_total": "0.00",
    "tags": "recovered",
    "created_at": "2024-04-19T09:51:30Z",
    "updated_at": "2024-04-19T10:02:25Z",
    "canceled_at": null,
    "customer_deleted_at": null,
    "deleted_at": null,
    "placed_at": "2024-04-19T09:54:02Z",
    "total_refund_price": "0.00",
    "total_refund_tax": "0.00",
    "total_refund_discount": "0.00",
    "refund_status": null,
    "total_tip_received": "0.00",
    "browser_ip": "183.15.177.205",
    "source": "https://test-shoplazza.stg.myshoplaza.com/checkout/633130-00000001?key=e281e6f81c335487dd91cf3df34a8e",
    "last_landing_url": "https://test-shoplazza.stg.myshoplaza.com/checkout/633130-00000001?key=e281e6f81c335487dd91cf3df34a8e",
    "email_status": "send",
    "recovery_status": "success",
    "total_paid": "109.90",
    "source_name": {
      "data": "Others",
      "created_at": ""
    },
    "last_referrer_show": {
      "data": "Others",
      "created_at": ""
    },
    "shipping_line": {
      "name": "test"
    },
    "customer": {
      "id": "f6de152d-ec40-4734-81e5-62db979da04e",
      "email": "[email protected]",
      "first_name": "zhang",
      "last_name": "senjun",
      "phone": "+8615014471143",
      "created_at": "2024-04-17T08:43:37Z",
      "updated_at": "2024-04-19T09:51:54Z",
      "orders_count": 2,
      "total_spent": "30.28"
    },
    "shipping_address": {
      "first_name": "test",
      "last_name": "test",
      "address1": "6 三聖街",
      "address2": "1111",
      "phone": "+8615014471143",
      "city": "北京",
      "zip": "100000",
      "province": "Beijing",
      "country": "China mainland",
      "company": "",
      "latitude": null,
      "longitude": null,
      "name": "test test",
      "country_code": "CN",
      "province_code": "CN-BJ",
      "phone_area_code": "CN_86",
      "email": "[email protected]",
      "area": "",
      "extra_info": null
    },
    "billing_address": {
      "first_name": "test",
      "last_name": "test",
      "address1": "6 三聖街",
      "address2": "1111",
      "city": "北京",
      "zip": "100000",
      "province": "Beijing",
      "country": "China mainland",
      "company": "",
      "latitude": null,
      "longitude": null,
      "name": "test test",
      "country_code": "CN",
      "province_code": "CN-BJ",
      "email": "[email protected]",
      "area": "",
      "phone": "+8615014471143"
    },
    "payment_line": {
      "payment_channel": "bogus",
      "payment_method": "bogus_gateway",
      "transaction_no": "test_633130-00000007",
      "merchant_id": "",
      "merchant_email": ""
    },
    "payment_lines": [
      {
        "payment_channel": "bogus",
        "payment_method": "bogus_gateway",
        "transaction_no": "test_633130-00000007",
        "merchant_id": "",
        "merchant_email": "",
        "paid_total": "109.90"
      }
    ],
    "line_items": [
      {
        "id": "ed8af005-1f4e-42d1-859d-99b0fd420781",
        "product_id": "a1a88be0-a1d4-47e4-a2f2-ba6e131cf447",
        "variant_id": "a7175820-36b3-4fc6-9baf-51e3035242ba",
        "variant_title": "L-blue-T",
        "product_title": "shirt",
        "product_handle": "shirt",
        "quantity": 1,
        "note": "",
        "fulfillment_status": "waiting",
        "sku": "T-M-L-blue-T-A001008",
        "weight_unit": "kg",
        "vendor": "shoplazza",
        "product_url": "/products/shirt",
        "compare_at_price": "97.00",
        "image": "//cdn.shoplazza.com/ccf0794c594bad32a320eea0d6bfe40c.jpeg",
        "price": "81.00",
        "total": "81.00",
        "weight": "1.10",
        "properties": [
          {
            "name": "size",
            "value": "L"
          },
          {
            "name": "color",
            "value": "blue"
          },
          {
            "name": "type",
            "value": "T"
          }
        ],
        "custom_properties": null,
        "refund_quantity": 0,
        "refund_total": "0.00",
        "base_price": "0.00",
        "discount_applications": "[{\"type\":\"discount_code\",\"subtype\":\"discount_code\",\"discount_id\":\"eedfd5d8-0fbd-4ec6-9055-a43ea68dbec8\",\"code\":\"HZV85Q4K\",\"title\":\"test\",\"value\":\"10\",\"discount_type\":\"percentage\",\"value_type\":\"percentage\",\"allocation_method\":\"\",\"target_selection\":\"all\",\"target_type\":\"line_item\",\"total_discount_amount\":\"8.1\",\"discount_amount\":\"8.1\",\"is_free_gift\":false,\"discount_quantity\":1,\"is_need_split\":false,\"discount_text\":\"Discount Code\"}]"
      }
    ],
    "fulfillments": [],
    "gift_card_total": "0.00",
    "shipping_tax_total": "0.00",
    "product_tax_included": true,
    "refer_info": "{\"$latest_referrer\":\"https://myaccount.stg.shoplazza.com/\",\"$latest_referrer_host\":\"myaccount.stg.shoplazza.com\",\"$latest_search_keyword\":\"未取到值\",\"$latest_traffic_source_type\":\"引荐流量\",\"address_check\":true,\"client_id\":\"1703040491710183\",\"country\":\"CN\",\"customer_session\":\"e198c29a-70bb-4f9d-9d43-b1ab12b557fb\",\"domain\":\"test-shoplazza.stg.myshoplaza.com\",\"fbc\":\"\",\"fbp\":\"fb.1.1701051195560.2038310036\",\"inventory_deduction\":\"order_created\",\"ip\":\"183.15.177.205\",\"session_id\":\"1713520243158272\",\"source\":\"buy_now\",\"user_agent\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36\"}",
    "additional_total": "0.00",
    "additional_prices": [],
    "logistics_code": "",
    "config": {
      "page_type": "three_step",
      "requires_shipping": true,
      "checkout_business_type": 0,
      "product_tax_included": true,
      "checkout_template_type": 0,
      "market_setting": {
        "primary_market_lang": "en-US",
        "market_lang": "en-US",
        "market_id": "370871064999238186",
        "market_currency": "CNY",
        "market_currency_symbol": {
          "code": "CNY",
          "val": "¥",
          "left": "¥",
          "right": ""
        },
        "market_base_id": "",
        "market_base_currency": "CNY",
        "market_base_currency_symbol": {
          "code": "CNY",
          "val": "¥",
          "left": "¥",
          "right": ""
        },
        "primary_market_id": "311711862569844266",
        "primary_market_currency": "USD",
        "primary_market_currency_symbol": {
          "code": "USD",
          "val": "$",
          "left": "$",
          "right": ""
        },
        "market_price_setting": {
          "local_currency_enabled": false,
          "custom_rate_enabled": false,
          "custom_rate": 0,
          "rate": 7.237698,
          "back_rate": 0.138165,
          "actual_rate": 7.237698,
          "base_to_local": 0,
          "local_to_base": 0,
          "adjust": 10,
          "price_round_enabled": true
        },
        "market_country": "CN"
      }
    }
  }
}

Refund

Refund properties

FieldTypeDesc
idstring
order_idstringOrder ID
notestringRefund note
refund_pricestringRefund amount
refund_line_itemsarray of RefundLineItemRefund line items

RefundLineItem

FieldTypeDesc
line_item_idstring
refund_quantityintegerQuantity to be refunded
line_itemarray of LineItemOrder line items

Example

{
  "id": "371916989850992298",
  "order_id": "633130-00000012",
  "note": "11111",
  "refund_price": "81.00",
  "currency": "CNY",
  "created_at": "2024-04-22T07:05:20Z",
  "updated_at": "2024-04-22T07:05:21Z",
  "refund_line_items": [
    {
      "refund_quantity": 1,
      "line_item_id": "7037bd0b-cb6b-453a-a936-b349d0c8bf5d",
      "line_item": {
        "id": "7037bd0b-cb6b-453a-a936-b349d0c8bf5d",
        "product_id": "a1a88be0-a1d4-47e4-a2f2-ba6e131cf447",
        "variant_id": "88e68830-4ef5-4125-bf7d-aef8047176b2",
        "variant_title": "S-blue-T",
        "product_title": "shirt",
        "product_handle": "shirt",
        "quantity": 2,
        "note": "",
        "fulfillment_status": "partially_returned",
        "sku": "T-M-S-blue-T-A001004",
        "weight_unit": "kg",
        "vendor": "shoplazza",
        "product_url": "/products/shirt",
        "compare_at_price": "97.00",
        "image": "//cdn.shoplazza.com/ccf0794c594bad32a320eea0d6bfe40c.jpeg",
        "price": "81.00",
        "total": "162.00",
        "weight": "1.10",
        "properties": [
          {
            "name": "size",
            "value": "S"
          },
          {
            "name": "color",
            "value": "blue"
          },
          {
            "name": "type",
            "value": "T"
          }
        ],
        "custom_properties": null,
        "refund_quantity": 0,
        "refund_total": "81.00",
        "base_price": "0.00",
        "discount_applications": ""
      }
    }
  ]
}