AppsThemesSupport
API Reference

Order Details

get https://{shopdomain}.myshoplaza.com/openapi/2022-01/orders/

๐Ÿ”’

Requires read_order access scope. More access scope

Response Description

๐Ÿ“˜

The relationships between entities.

FieldsTypeDesc
idstringorder id
numberstringOrder's number(more convenient for merchants)
notestringmerchant input for taking a note
statusstringOrder status
financial_statusstringFinancial status
fulfillment_statusstringFulfillment status
cancel_reasonstring
recovery_statusstringRecovery status:
waiting means โ€œto be recalledโ€
sending means โ€œsentโ€
recalling means โ€œrecall in progressโ€
failed means โ€œrecall failedโ€
success means โ€œrecall successfulโ€
payment_methodstringPayment method,such as apple_pay,cod,credit_card,online etc.
discount_codestring@Deprecated.
discount_applicationsstringDetails of discounts
customer_notestringCustomer's order note.
landing_sitestring@Do not focus too much.
sales_platform@Do not focus too much.
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 order's products , numeric string, for example: "9.99" .If order.config.product_tax_included is true, the amount includes total_tax (not includes shipping_tax_total), otherwise it does notใ€‚order.sub_total = sum(line_item.total_price) = sum(line_item.price*line_item.quantity)
product_tax_includedboolrefer to "sub_total"
total_discountstringTotal discount price of order, numeric string, for example: "9.99", include product discount,shipping discount and payment discount.
total_taxstringSales tax on the order or Tax on the order product items., numeric string, for example: "9.99"
total_shippingstringOrder logistics total fee, numeric string, for example: "9.99"
code_discount_totalstringOrder discount code discount price, numeric string, for example: "9.99"
line_item_discount_totalstring@Deprecated.total Product discount, numeric string, for example: "9.99",includes code_discount_total
gift_card_totalstringGift card discount amount, numeric string, for example: "9.99"
total_refund_pricestringTotal refund amount has been successfully processed, numeric string, for example: "9.99"
refund_statusstringRefund status:
pending -
failed -
finished -
total_refund_discountstring@Deprecated.Total discount refunded, numeric string, for example: "9.99"
additional_totalstringTotal amount of additional charges, numeric string, for example: "9.99"
additional_pricesarray of AdditionalPriceAdditional fees, such as: shipping insurance, etc.
additional_prices.namefee type
additional_prices.pricestringthe total of this fee type
additional_prices.biz_idstring@Do not focus too much.
total_refund_taxstring@Deprecated.
shipping_tax_totalstringTotal shipping tax amount for the order.
customer_deleted_atstringTime of user deletion
created_atstring
updated_atstring
deleted_atstringDeletion time
canceled_atstring
placed_atstringPayment time
total_tip_receivedstring
tagsstringMerchant tags the order
browser_ipstring@Do not focus too much.
email_statusstringRecovery email status:
waiting means โ€œpending to sendโ€
send means โ€œsentโ€
last_landing_urlstring@Do not focus too much.
total_paidstringTotal payment amount
sourcestring@Do not focus too much.
source_nameobject@Do not focus too much.
source_name.datastring@Do not focus too much.
source_name.created_atstring@Do not focus too much.
last_referrer_showobject@Do not focus too much.
last_referrer_show.datastring@Do not focus too much.
last_referrer_show.created_atstring@Do not focus too much.
shipping_lineobjectShipping plan
shipping_line.namestring
customerObjectCustomer details
customer.idstring
customer.emailstring
customer.first_namestring
customer.last_namestring
customer.phonestring
customer.created_atstring
customer.updated_atstring
customer.orders_countintthe created order of this customer
customer.total_spentstringCustomer's total expenditure.
shipping_addressObjectDelivery address
shipping_address.first_namestring
shipping_address.last_namestring
shipping_address.address1string
shipping_address.address2string
shipping_address.phonestring
shipping_address.citystring
shipping_address.zipstring
shipping_address.provincestring
shipping_address.countrystring
shipping_address.companystring
shipping_address.namestring
shipping_address.Latitudestring
shipping_address.Longitudestring
shipping_address.country_codestring
shipping_address.province_codestring
shipping_address.phone_area_codestring
shipping_address.emailstring
shipping_address.areastring
shipping_address.extra_infojson"extra_info": {
"cpf":"123.123.123-12", // Tax ID
"id_number":"32010219800101001X", // Identity Card Number
"id_number_text":"Resident Identity Card", // Identity Card Description
"tax_text":"Tax ID" // Tax ID Description
}
billing_addressObjectBilling address
billing_address.first_namestring
billing_address.last_namestring
billing_address.emailstring
billing_address.country_codestring
billing_address.countrystring
billing_address.province_codestring
billing_address.provincestring
billing_address.areastring
billing_address.citystring
billing_address.addressstring
billing_address.address1string
billing_address.zipstring
billing_address.companystring
billing_address.phonestring
payment_lineObjectone of payment_lines
payment_line.payment_namestring
payment_line.payment_channelstringsuch as : cod,dlocal,
,ebanxlocal, oceanapple etc.
payment_line.payment_methodstringsuch as: thirdpay/online/apple_pay/cod etc.
payment_line.transaction_nostring
payment_line.merchant_idstring
payment_line.merchant_emailstring
payment_line.paid_totalstringtotal payment amount
payment_linesarray of Payment_line objectIf there are multiple payment methods, then return all the payment methods.
payment_lines.payment_namestring
payment_lines.payment_channelstring
payment_lines.payment_methodstring
payment_lines.transaction_nostring
payment_lines.merchant_idstring
payment_lines.merchant_emailstring
payment_lines.paid_totalstring
line_itemsarray of orderlineItem OjbectList of purchased products
line_items.idstring
line_items.product_idstring
line_items.variant_idstring
line_items.variant_titlestring
line_items.product_titlestring
line_items.product_handlestring@Do not focus too much.
line_items.quantitystringthe number of product
line_items.notestring
line_items.fulfillment_statusstringLogistics status:
initialled (empty),
waiting (pending shipment),
partially_shipped (partially shipped),
shipped (shipped),
partially_finished (partially completed),
finished (completed),
cancelled (cancelled),
returning (returning),
returned (returned).
line_items.skustring
line_items.weight_unitstring
line_items.vendorstringProduct supplier
line_items.product_urlstring
line_items.compare_at_pricestringOriginal price of the product
line_items.imagestring
line_items.pricestringsales price
line_items.totalstringtotal_price = price *quantity
line_items.weightstring
line_items.propertiesObject of LineItemOption
line_items.properties.namestring
line_items.properties.valuestring
line_items.custom_propertiesjson
line_items.refund_quantitystring@Deprecated
line_items.refund_totalstring@Deprecated refund_total=refund_quantity*
line_items.base_pricestring@Do not focus too much.
line_items.discount_applicationsstringDetailed information on discounts.
line_items.requires_shippingboolif true means requires logistics.
fulfillmentsarray of Fulfillment ObjectList of fulfillments
fulfillments.idstring
fulfillments.order_idstring
fulfillments.statusstringWaybill status๏ผš
waiting (Pending Shipment),
shipped (Shipped),
finished (Completed),
cancelled (Cancelled)
fulfillments.tracking_companystring
fulfillments.tracking_numberstring
fulfillments.tracking_company_codestring
fulfillments.created_atstring
fulfillments.updated_atstring
fulfillments.line_itemsarray of FulfillmentLineItemLogistics information for the product in transit.
fulfillments.line_items.idstring
fulfillments.line_items.product_idstring
fulfillments.line_items.variant_idstring
fulfillments.line_items.variant_titlestring
fulfillments.line_items.product_titlestring
fulfillments.line_items.product_handlestring@Do not focus too much.
fulfillments.line_items.quantitystring
fulfillments.line_items.notestring
fulfillments.line_items.fulfillment_statusstring
fulfillments.line_items.skustring
fulfillments.line_items.weight_unitstring
fulfillments.line_items.vendorstring
fulfillments.line_items.product_urlstring
fulfillments.line_items.compare_at_pricestring
fulfillments.line_items.imagestring
fulfillments.line_items.pricestring
fulfillments.line_items.totalstring
fulfillments.line_items.weightstring
fulfillments.line_items.propertiesstring
fulfillments.line_items.properties.namestring
fulfillments.line_items.properties.vaulestring
fulfillments.line_items.custom_propertiesjson
fulfillments.line_items.refund_quantitystring
fulfillments.line_items.refund_totalstring
fulfillments.line_items.taxableboolif true means contains tax
fulfillments.line_items.requires_shippingboolif true means requires logistics.
fulfillments.line_items.shipping_quantitystring
fulfillments.phone_numberstring
logistics_codestringLogistics code
refer_infostringthe information of visited user agent
configObject of orderconfigOrder configuration information
config.page_typestringPayment type
config.requires_shippingboolWhether shipping is required
config.checkout_business_typeint@Do not focus too much.
config.product_tax_includedboolWhether the product includes tax
config.checkout_template_typeint@Do not focus too much.
config.market_settingObject of MarketSetting
config.market_setting.primary_market_langstringPrimary market language
config.market_setting.market_langstringCurrent market language, for example: en-US
config.market_setting.market_idstringMarket configuration ID
config.market_setting.market_currencystringMarket currency code, for example: USD
config.market_setting.market_currency_symbolobject of CurrencySymbol
config.market_setting.market_currency_symbol.codestringCurrency code, for example: USD
config.market_setting.market_currency_symbol.valstringCurrency symbol, for example: $
config.market_setting.market_currency_symbol.leftstringContent displayed to the left of the number, for example: $
config.market_setting.market_currency_symbol.rightstringContent displayed to the right of the numbe
config.market_setting.market_base_idstring
config.market_setting.market_base_currencystring
config.market_setting.market_base_currency_symbolobject of CurrencySymbol
config.market_setting.primary_market_id
config.market_setting.primary_market_currency
config.market_setting.primary_market_currency_symbolobject of CurrencySymbol
config.market_setting.market_price_settingobject of MarketPriceSetting
config.market_setting.market_price_setting.local_currency_enabledboolLocal currency enable status
config.market_setting.market_price_setting.custom_rate_enabledboolCustom rate enable status
config.market_setting.market_price_setting.custom_ratefloatCustom rate, primary market currency -> market base currency
config.market_setting.market_price_setting.ratefloatprimary market currency -> market base currency / local currency
config.market_setting.market_price_setting.back_ratefloatmarket base currency / local currency -> primary market currency
config.market_setting.market_price_setting.actual_ratefloatActual exchange rate, primary market currency -> market base currency / local currency
config.market_setting.market_price_setting.base_to_localfloatmarket base currency -> local currency
config.market_setting.market_price_setting.local_to_basefloat
config.market_setting.market_price_setting.adjustfloatPrice adjustment
config.market_setting.market_price_setting.price_round_enabledboolEnable price rounding
config.market_setting.market_countrystringMarket country, for example: US
config_infojsonjson of config
location_lineobject of LocationLine
location_line.id
location_line.location_id
location_line.location_name
checkout_urlstringThe link used for payment of this order.
primary_market_priceobject of PrimaryMarketPrice
primary_market_price.pricestringPrices converted into primary market currencies
primary_market_price.actual_ratefloatThe actual exchange rate against the primary currency

Error Detail

ErrorCodeDescriptionPossible reasons
Record not found
406
400
500StatusInternalServerErrorAborted/NotFound/Unimplemented/Unauthenticated/DeadlineExceeded

Request Params

Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!

Support

Shoplazza

Updates

Partner Program

Support

Shoplazza

Updates

Partner Program

Follow Us

ยฉ Shoplazza
Partner Program Agreement API Terms Terms of Service Privacy Policy Use Policy