--- title: "Get orders" description: > Get order details in bulk based on specified request information. For example, you can get orders by the order creation time or update time, or specify an order ID to get details for a single order. doc_type: openapi doc_category: openapi doc_version: v20270301 source_url: html: 'https://developer.shopline.com/docs/admin-rest-api/order/order-management/get-orders' md: 'https://developer.shopline.com/docs/admin-rest-api/order/order-management/get-orders.md' --- # Get orders Get order details in bulk based on specified request information. For example, you can get orders by the order creation time or update time, or specify an order ID to get details for a single order. - **Base URL:** `https://{handle}.myshopline.com/admin/openapi` - **Required Scopes:** `read_orders` - **API Version:** v20270301 - **API Type:** Admin - **API Protocol:** RESTful ## Endpoint ```http GET /orders.json ``` ## Base URL * `https://{handle}.myshopline.com/admin/openapi` * `{handle}`: `handle` : The store's unique identifier, which is the prefix of the store's domain name. For example, if a store's domain name is `open001.myshopline.com` , the store handle is `open001` . ## Required Permissions * `read_orders` ## Request ### Query Parameters * `created_at_min` string (optional) Specify the start date and time for filtering orders by order creation time. The system returns orders created at and after this time. Format：[ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). * `financial_status` string (optional) The payment status of the order. Valid values are: - `unpaid`: order not paid - `authorized`: order payment has been authorized - `pending`: order payment in progress - `partially_paid`: order partially paid - `paid`: order paid - `partially_refunded`: order partially refunded - `refunded`: order fully refunded * `order_at_max` string (optional) Specify the end date and time for filtering orders by order time. The system returns orders placed at this time and up to 1 year prior. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). * `order_at_min` string (optional) Specify the start date and time for filtering orders by order time. The system returns orders placed at this time and up to 1 year after. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). * `page_info` string (optional) The unique identifier for pagination queries, used to locate a specific page. This parameter value is obtained from the `link` value in the response header of this API after you have queried the pagination information. For example, if the `link` value you obtained is `; rel="next"` , the value of `page_info` is `eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9` . For more information on how to use pagination, refer to [Paging Mechanism](https://developer.shopline.com/docs/apps/api-instructions-for-use/paging-mechanism.md). * `updated_at_min` string (optional) Specify the start date and time for filtering orders by order update time. The system returns orders updated at and after this time. Format：[ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). * `created_at_max` string (optional) Specify the end date and time for filtering orders by order creation time. The system returns orders created at and before this time. Format：[ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). * `fulfillment_status` string (optional) The shipment status of the order. Valid values are: - `unshipped`: order not shipped - `partial`: order partially shipped - `shipped`: order shipped Default value: `unshipped` :::warning **Caution**: The accuracy of the inputted value will be strictly validated. If the value fails validation, the order query will fail and an error `fulfillment status value is illegal` will be triggered. ::: * `ids` string (optional) Order IDs, separated by commas. Up to a maximum of 100 IDs. * `location` string (optional) The ID of the location where the products in the order are fulfilled, or the POS transaction point ID. You can specify multiple location IDs by separating them with commas. * `search_content` string (optional) Search content, such as order number, payment serial number, express delivery number, product name, product SKU number, and order amount. * `sort_condition` string (optional) Specify the sorting conditions for order results. You can sort by fields `order_at` (order creating time) or `id` (order ID), and each field can be specified as either `asc`(ascending) or `desc`(descending). Use commas to separate multiple sorting conditions. For example, if you specify the value of this field as `order_at:desc, id:asc`, order results will first be sorted in descending order by order creation time, then in ascending order by order ID. * `contract_ids` string (optional) Subscription contract IDs. You can specify multiple IDs by separating them with commas, up to a maximum of 50 IDs. * `email` string (optional) Email of the buyer who placed the order. * `limit` string (optional) The maximum number of orders to return per request. Valid values range from `1` to `100`. The default value is `20`. * `name` string (optional) Order number. Different from the order ID, this number can have a custom prefix set in the SHOPLINE Admin. * `since_id` string (optional) The starting position of the order number ID of the data to be queried. * `buyer_id` string (optional) The ID of the buyer who placed the order. * `fields` string (optional) Specify the fields to query, separated by commas. If not specified, all field information is returned. * `hidden_order` string (optional) Whether orders to query are archived. - `true`: The orders are archived. - `false`: The orders are not archived. Default value: `false` * `status` string (optional) Order status. Valid values are: - `open`: order in process - `cancelled`: order canceled - `any`: contains many other statues, such as order archived * `updated_at_max` string (optional) Specify the end date and time for filtering orders by order update time. The system returns orders updated at and before this time. Format：[ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). ### Request Headers * `Content-Type` string (required) The field must be set to the fixed value `application/json; charset=utf-8`. * `Authorization` string (required) The access token for the API resource. Refer to [App authorization](https://developer.shopline.com/docs/apps/api-instructions-for-use/app-authorization.md?lang=en) to obtain the access token, and then pass the obtained token in the Bearer format. ## Response ### Status Codes * `200` For the complete list of codes and messages, see [Http status code](https://developer.shopline.com/docs/apps/api-instructions-for-use/http-status-code.md?lang=en). * `401` * `429` ### Response Headers * `link` The URL link that provides the pagination data. You can obtain `page_info` from this parameter for subsequent pagination requests. This parameter is returned when the requested page has a previous or next page. For more information on how to use pagination, refer to [Paging Mechanism](https://developer.shopline.com/docs/apps/api-instructions-for-use/paging-mechanism.md). * `traceId` A globally unique identifier for the request. It is used to track the request flow throughout the system, allowing for easy location and debugging when issues arise. ### Response Body #### 200 * `orders` array List of order details. * `adjust_price` string The amount discrepancy due to rounding adjustments in POS transactions, expressed in the store currency. * `adjust_price_set` object The amount discrepancy due to rounding adjustments in POS transactions, displayed in both the buyer currency and the store currency. * `presentment_money` object The amount discrepancy information presented to the buyer. * `amount` string The adjusted price amount. The value is rounded to two decimal places. * `currency_code` string A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. * `shop_money` object The amount discrepancy information recorded by the store. * `amount` string The adjusted price amount. The value is rounded to two decimal places. * `currency_code` string A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. * `billing_address` object The address for sending billing invoices. * `address1` string The first line of the address. This typically includes information such as the street address or a post office box number. * `address2` string The second line of the address. This typically includes information such as apartment, suite, or unit number. * `city` string The city in the address. * `company` string The company name of the billing recipient. * `country` string The country or region in the address. * `country_code` string A two-letter country or region code that follows the [ISO 3166-1](https://www.iso.org/iso-3166-country-codes.html) standard, used to identify a specific country or region in the address. * `first_name` string The first name of the billing recipient. * `last_name` string The last name of the billing recipient. * `name` string The full name of the billing recipient. * `phone` string The phone number of the billing recipient. * `province` string The province in the address. * `province_code` string The code for the province in the billing address, which can be a custom code or a two-digit [ISO 3166-2](https://www.iso.org/iso-3166-country-codes.html#2012_iso3166-2) international code. * `standard_province_code` string The code for the province in the billing address, which is a two-digit [ISO 3166-2](https://www.iso.org/iso-3166-country-codes.html#2012_iso3166-2) international code.This differs from `province_code` - the `province_code` response field uses a custom code. * `zip` string The postal code information of the address. * `browser_ip` string The client IP address captured when the buyer places an order. * `buyer_note` string Buyer's message. * `cancel_reason` string Merchant's reason for cancellation. * `cancelled_at` string The date and time when the order was canceled. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). * `cart_token` string The unique identifier for shopping cart data. * `checkout_id` string Abandoned order ID. * `checkout_token` string The unique identifier for abandoned order data. After a customer initiates the checkout process, an abandoned order is generated. * `client_details` object Client details. * `browser_ip` string The client IP address captured when the buyer places an order. * `session_hash` string Member session encrypted information. * `user_agent` string User agent. * `company` object The buyer's company information as recorded at the time the order was placed. * `id` string Company ID. * `location_id` string Location ID. * `tax_registration_id` string Tax registration ID. * `contract_seq` string Subscription contract ID. * `created_at` string The date and time when the order was created. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). * `credit_limit` object Payment information (credit limit). * `credit_limit_currency` string The currency of the credit payment, same as the store currency. The value of this parameter is a three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. * `is_credit_limit` boolean Whether the order was paid using the credit limit (payment terms). - `true`: used - `false`: not used * `outstanding_credit_limit` string The current outstanding credit limit total for the order. This value decreases as the buyer makes payments toward the order. * `total_credit_limit` string The initial credit limit total used for the order (equal to the initial outstanding credit limit total). * `currency` string Transaction currency. A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. * `current_subtotal_price` string The total amount of products, calculated by multiplying the unit price by the quantity and displayed in the store currency. * `current_subtotal_price_set` object The total amount of products, calculated by multiplying the unit price by the quantity and displayed in both the buyer currency and the store currency. * `presentment_money` object The order price information presented to the buyer. * `amount` string The order amount. The value is rounded to two decimal places. * `currency_code` string A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. * `shop_money` object The order price information recorded by the store. * `amount` string The order amount. The value is rounded to two decimal places. * `currency_code` string A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. * `current_total_discounts` string The total discount amount in the store currency. It is calculated by adding marketing discounts and custom discounts, with the resulting amount rounded to two decimal places. * `current_total_discounts_set` object The total discount amount displayed in both the buyer currency and the store currency. It is calculated by adding marketing discounts and custom discounts, with the resulting amount rounded to two decimal places. * `presentment_money` object The total discount amount information presented to the buyer. * `amount` string The total discount amount. The value is rounded to two decimal places. * `currency_code` string A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. * `shop_money` object The total discount amount information recorded by the store. * `amount` string The total discount amount. The value is rounded to two decimal places. * `currency_code` string A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. * `current_total_duties_set` object The total customs duties for the products, displayed in both the buyer currency and the store currency. * `presentment_money` object The total customs duties information for the products presented to the buyer. * `amount` string The duty amount. The value is rounded to two decimal places. * `currency_code` string A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. * `shop_money` object The total customs duties information for the products recorded by the store. * `amount` string The duty amount. The value is rounded to two decimal places. * `currency_code` string A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. * `current_total_price` string The total order amount, displayed in the store currency. * `current_total_price_set` object The total order amount, displayed in both the buyer currency and the store currency. * `presentment_money` object The order price information presented to the buyer. * `amount` string The total order amount. The value is rounded to two decimal places. * `currency_code` string A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. * `shop_money` object The order price information recorded by the store. * `amount` string The total order amount. The value is rounded to two decimal places. * `currency_code` string A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. * `current_total_tax` string The total tax amount, displayed in the store currency. * `current_total_tax_set` object The total tax amount, displayed in both the buyer currency and the store currency. * `presentment_money` object The tax information presented to the buyer. * `amount` string The tax amount. The value is rounded to two decimal places. * `currency_code` string A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. * `shop_money` object The tax information recorded by the store. * `amount` string The tax amount. The value is rounded to two decimal places. * `currency_code` string A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. * `customer` object Buyer information. * `addresses` object Buyer's address information. * `address1` string The first line of the address. This typically includes information such as the street address or a post office box number. * `address2` string The second line of the address. This typically includes information such as apartment, suite, or unit number. * `city` string The city in the address. * `country` string The country or region in the address. * `country_code` string A two-letter country or region code that follows the [ISO 3166-1](https://www.iso.org/iso-3166-country-codes.html) standard, used to identify a specific country or region in the address. * `first_name` string The first name of the recipient. * `last_name` string The last name of the recipient. * `name` string The full name of the recipient. * `phone` string The phone number of the buyer. * `province` string The province in the address. * `province_code` string The code for the province in the billing address, which can be a custom code or a two-digit [ISO 3166-2](https://www.iso.org/iso-3166-country-codes.html#2012_iso3166-2) international code. * `zip` string The postal code information of the address. * `area_code` string The area or country code for the phone number. * `created_at` string The date and time when the buyer information was created. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). * `currency` string A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. * `email` string The email of the buyer. * `first_name` string The first name of the buyer. * `id` string Buyer's ID. * `last_name` string The last name of the buyer. * `phone` string The phone number of the buyer. * `updated_at` string The date and time when the buyer's information was updated. Format：[ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). * `customer_locale` string Buyer's language code + country or region code. The language code follows the [ISO 639](https://www.iso.org/iso-639-language-code) standard. Country or region code follows the [ISO 3166-1](https://www.iso.org/glossary-for-iso-3166.html) standard. * `deduct_member_point_amount` string The amount deducted from the order using member points, expressed in the store currency and rounded to two decimal places. * `deduct_member_point_amount_set` object The amount deducted from the order using member points, displayed in both the buyer currency and the store currency. * `presentment_money` object The deduction amount information presented to the buyer. * `amount` string The deduction amount. The value is rounded to two decimal places. * `currency_code` string A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. * `shop_money` object The deduction amount information recorded by the store. * `amount` string The deduction amount. The value is rounded to two decimal places. * `currency_code` string A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. * `discount_applications` array A list of discount information. * `activity_type` integer The type of promotion applied to the product line: - `0`: Flash Sale - `1`: Time-Limited Promotion - `2`: Bundle Offer - `3`: Discount Code - `4`: One-Page Store - `5`: Free Gift - `6`: Pre-Order - `7`: Add-On Item - `8`: Gift Box - `9`: Product Upsell Campaign * `allocation_method` string The discount scope. Valid values are: - `across`: The discount is applied to the total product amount. - `each`: The discount is applied to each product individually. Example: Assume the store currency is CNY. For the purchase of three identical items with a discount amount of 10 CNY, if `allocation_method` is `across`, the total price of the three items is reduced by 10 CNY; if `allocation_method` is `each`, the price of each item is reduced by 10 CNY. * `benefit_type` integer The type of discount applied to the product line: - `-1`：No discount - `1`：Amount reduction - `2`：Discount - `3`：Free shipping fee - `4`：Marked-up item - `5`：Preferential price for any N items - `6`：Preferential price for the combination of A and B - `7`：Gift - `8`：Fixed selling price - `9`：The lowest-priced item is free - `11`：Discount for the Nth item - `12`：Buy x and get y free - `13`：Customized - `14`：M (Monetary Unit) for N Items * `code` string Discount code. * `description` string Custom discount description. * `target_selection` string Discount allocation method for line items. Valid values are: - `explicit`: The discount is allocated only to the explicitly specified line items. - `all`: The discount is allocated to all line items. - `entitled`: The discount is allocated only to the line items that are entitled to use the discount. * `target_type` string Discount target type. Valid values are: - `line_item`: discount applied to the product - `shipping_line`: discount applied to the shipping fee * `title` string Automatic discount title. * `type` string Discount type. Valid values are: - `manual`: manual discount - `automatic`: automatic discount - `discount_code`: discount applied through a discount code * `value` string The specific value of the discount, in the store currency. - When `value_type` is `fix_amount`, this field value represents a specific discount amount. For example, if the value is `10` in CNY, it means a discount of 10 yuan. - When `value_type` is `percentage`, the value of this field value represents a specific discount percentage. For example, `10` means 10% off of the order amount. * `value_type` string The type of discount value. Valid values are: - `fix_amount`: Fixed amount discount. For example, if `value` is `10` in CNY, it means a discount of 10 yuan. - `percentage`: Percentage-based discount. For example, if `value` is `10`, it means 10% off of the order amount. * `discount_codes` array A list of promo code information. * `amount` string Discount amount in the store currency. The value is rounded to two decimal places. * `amount_set` object The discount amount, displayed in both the buyer currency and the store currency. * `presentment_money` object The discount amount information presented to the buyer. * `shop_money` object The discount amount information recorded by the store. * `code` string Promo code. * `type` string Type of discount. Valid values are: - `减金额`: amount reduction - `打折`: offer a discount - `免运费`: free shipping - `加价品`: add-on purchase deal - `任意N件优惠价`: discount for purchasing any N items - `A+B组合优惠价`: discount for purchasing the product A and B combo - `赠品`: free gift - `固定售价`: fixed price - `最低价商品免费`: lowest-priced product free - `打包价`: package price - `第N件打折`: discount on the Nth item - `买x送y`: buy x and get y free - `自定义`: custom discount :::danger **DEPRECATED**：This parameter is deprecated from API version v20241201. ::: * `email` string Buyer's email. * `financial_status` string Order payment status. Valid values are: - `unpaid`: order not paid - `authorized`: order payment has been authorized - `pending`: order payment in progress - `partially_paid`: order partially paid - `paid`: order paid - `partially_refunded`: order partially refund - `refunded`: order refund * `fulfillment_status` string Shipping status. Valid values are: - `fulfilled`: order shipped - `partial`: order partially shipped - `null`: order not shipped * `fulfillments` array A list of fulfillment information. * `created_at` string The date and time when the fulfillment was created. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). * `id` string Fulfillment ID. * `line_items` array Product list. * `attribute` string The option information of the product variant, composed of the variant name and the option value. * `bundle_parent_variant_id` string Parent product variant ID associated with the bundle child product. * `fulfillable_quantity` integer Remaining fulfillable quantity of products at the product line level. * `fulfillment_quantity` integer The quantity of products that are actually shipped. * `fulfillment_service` string Logistics company name. * `fulfillment_status` string Shipping status. Valid values are: - `fulfilled`: order shipped - `partial`: order partially shipped - `null`: order not shipped * `grams` double The weight of the product in grams(g). * `id` string The ID of the product snapshots table, generated by the system. Combined with the `order.id`, it uniquely identifies a product. * `image_url` string The URL address that stores the product image. * `is_bundle` boolean Whether the product is a bundle. - `true`: The product is a bundle. - `false`: The product is not a bundle. * `is_bundle_component` boolean Whether the product is a sub-item in a bundle. - `true`: The product is a sub-item in a bundle. - `false`: The product is not a sub-item in a bundle. * `location_id` string The unique ID of the pickup location. * `name` string SKU title, same as `title`. * `price` string The product price in store currency. The value is rounded to two decimal places. * `price_set` object The product price, displayed in both the store currency and the buyer currency. * `product_id` string SPU serial number. * `quantity` integer Quantity of items in the order. * `requires_shipping` boolean Indicates whether the product is subject to shipping. - `true`：Shipping is required. - `false`：Shipping is not required. * `sku` string Product SKU serial number. * `tax_lines` array A list of tax information. * `taxable` boolean Whether the product is subject to tax. - `true`: Tax is required. - `false`: No tax is required. * `title` string Product title. * `variant_id` string A unique code assigned to a distinct product in inventory. * `variant_title` string Product variant value. Multiple values are separated by `/`. * `vendor` string Supplier. * `name` string Fulfillment code. * `order_id` string Order number. * `shipment_status` string Product delivery status. Valid values are: - `out_for_delivery`: out for delivery - `delivered`: delivered - `faliure`: delivery failed - `picked_up`: picked up * `status` string Shipping status of the order package. Valid values are: - `success`: shipment dispatched - `cancelled`: shipment has been canceled * `tracking_company` string Logistics service provider. * `tracking_info_list` array If this parameter is specified, the individual parameters `tracking_url`, `tracking_number`, and `tracking_company` will be ignored.Maximum of 10 tracking infos allowed. * `tracking_company` string The URL for tracking the package. * `tracking_number` string The logistics service provider. * `tracking_url` string The tracking number. * `tracking_number` string The delivery tracking number provided by the logistics service provider. * `tracking_url` string The domain name of the logistics company. * `updated_at` string The date and time when the fulfillment was updated. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). * `hidden_order` boolean Indicates whether the order is archived. - `true`: The order is archived. - `false`: The order is not archived. * `id` string Order ID, system-defined number. * `landing_site` string Link to record complete order attribution landing page information. * `line_items` array A list of order product snapshot. * `attribute` string The option information of the product variant, composed of the variant name and the option value. * `bundle_parent_variant_id` string Parent product variant ID associated with the bundle child product. * `country_code_of_origin` string Country or region code indicating the place of origin or shipping origin. Format: [ISO 3166-1](https://www.iso.org/iso-3166-country-codes.html). * `customized_attributes` array A list of product custom attributes. * `key` string Product custom attribute name, imported from external sources. When `key` is `businessType`, `value` is fixed to `3`, indicating a gift. * `value` string Product custom attribute value. When `key` is `businessType`, `value` is fixed to `3`, indicating a gift. * `discount_allocations` array The discount amount, displayed in both the buyer currency and the store currency. * `amount` string The discount amount. The value is rounded to two decimal places. * `amount_set` object Discount details in multiple currencies. * `discount_application_index` integer The position of the discount applied to the product within the `orders.discount_applications` list. * `duties` array A list of duty information. * `country_code_of_origin` string Country or region code indicating the place of origin or shipping origin. Format: [ISO 3166-1](https://www.iso.org/iso-3166-country-codes.html). * `harmonized_system_code` string Harmonized system code, used to categorize a product in international trade. * `id` string Tariff number. * `price` object The duty amount, displayed in both the buyer currency and the store currency. * `tax_lines` array A list of tax information. * `fulfillable_quantity` integer Remaining fulfillable quantity at product line level. * `fulfillment_service` string Logistics company name. * `fulfillment_status` string Shipping status. Valid values are: - `fulfilled`: order shipped - `partial`: order partially shipped - `null`: order not shipped * `gift_card` boolean Whether the product is a gift card. - `true`: gift card - `false`: not a gift card * `grams` double The weight of the product in grams(g). * `harmonized_system_code` string Harmonized system code, used to categorize a product in international trade. * `id` string The ID of the product snapshots table, generated by the system. Combined with the `order.id`, it uniquely identifies a product. * `image_url` string The URL address that stores the product image. * `is_bundle` boolean Whether the product is a bundle. - `true`: The product is a bundle. - `false`: The product is not a bundle. * `is_bundle_component` boolean Whether the product is a sub-item in a bundle. - `true`: The product is a sub-item in a bundle. - `false`: The product is not a sub-item in a bundle. * `location_id` string Local delivery location number or standard delivery location number. * `name` string SKU title, same as `title`. * `price` string The product price in store currency. The value is rounded to two decimal places. * `price_set` object The product price, displayed in both the store currency and the buyer currency. * `presentment_money` object The product price information presented to the buyer. * `shop_money` object The product price information recorded by the store. * `product_id` string SPU serial number. * `properties` array A list of product customization information. * `additional` string Additional custom fields for products. For example, if `name` is `text`, `additional` can include attributes such as font size, font style, and color. * `name` string Custom attribute name. * `role_visibility` string Custom information visibility roles: - `customer`: Visible to buyers only - `merchant`: Visible to merchants only - ` all:` Visible to both buyers and merchants - `none`: Hidden from both buyers and merchants * `show` boolean Whether the property is visible. - `true`: The property is visible. - `false`: The property is not visible. * `type` string Custom information type. Valid values are: - `text`: text type - `picture`: picture type - `link`: hyperlink type * `urls` array URL resource list. - If `type` is `picture`, thumbnails are rendered via the `urls` values. - If `type` is `link`, the hyperlink is the first URL in the `urls` values. * `value` string Custom attribute value. * `quantity` integer Quantity of items in the order. * `requires_shipping` boolean Indicates whether the product is subject to shipping. - `true`：Shipping is required. - `false`：Shipping is not required. * `sku` string Product SKU serial number. * `tags` string Product tags. Multiple tags are separated by commas. * `tax_lines` array A list of tax information. * `price` string Tax in store currency. The value is rounded to two decimal places. * `price_set` object The tax amount, displayed in both the buyer currency and the store currency. * `rate` double The tax rate as a decimal value, rounded to four decimal places. For example, a 2% tax rate is represented as `0.0200`. This field value is for display only. * `title` string The title for the tax description, for display only. * `type` string Tax fee type, used to distinguish between commodity tax and freight tax. - `product_tax`: commodity tax - `shipping_tax`: freight tax * `taxable` boolean Whether the product is subject to tax. - `true`: Tax is required. - `false`: No tax is required. * `title` string Product title. * `variant_id` string A unique code assigned to a distinct product in inventory. * `variant_title` string Product variant value. Multiple values are separated by `/`. * `vendor` string Supplier. * `locations` array A list of product pickup location addresses. * `address` string The first line of the address. This typically includes information such as the street address or a post office box number. * `address_add` string The second line of the address. This typically includes information such as apartment, suite, or unit number. * `city` string The city in the address. * `country` string The country or region in the address. * `country_code` string A two-letter country or region code that follows the [ISO 3166-1](https://www.iso.org/iso-3166-country-codes.html) standard, used to identify a specific country or region in the address. * `district` string The district or county in the address. * `location_id` string Unique code of the pickup location. * `name` string Pickup location name. * `phone` string Phone number. * `province` string The province in the address. * `town` string The village or town in the address. * `type` string Location types. Valid values are: - `posLocation`: The store location where the order was placed using the POS channel. It is recommended to use `posLocationId`, because `posLocation` will be deprecated soon. - `pickupLocation`: The store location for customer pickup when the order's delivery method is self-pickup. - `productLocation`: The inventory location of the products in the order. It is recommended to use the `location` information in the product line, because `productLocation` will be deprecated soon. * `zip` string The postal code information of the address. * `name` string Store custom order number, starting from 1001. You can set a prefix for this value, such as `test1001`. * `note` string Merchant notes. * `note_attributes` array A list of merchant note logs. * `create_time` string Note creation date and time. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). * `name` string Merchant ID, indicating the note source. * `value` string Note content. * `order_at` string Order completion date and time. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). * `order_source` string The order source channel handle. The handle is a semantic identifier. * `order_status_url` string Order status page URL. * `payment_details` array A list of order payment information. * `create_time` string The date and time when the payment order was created. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). * `gateway` string Payment method name. * `giftcard_presentment_money` object The gift card amount information presented to the buyer. * `amount` string The giftcard amount. The value is rounded to two decimal places. * `currency_code` string A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. * `pay_amount` double Payment amount in the store currency. The value is rounded to two decimal places. * `pay_channel` string Payment channel. * `pay_channel_deal_id` string Payment serial number from the external channel. * `pay_merchant_email` string The email address of the payment service provider. * `pay_merchant_id` string Payment service provider ID. * `pay_merchant_order_id` string Payment service provider order number. * `pay_seq` string Payment order number. * `pay_status` string Payment status. Valid values are: - `unpaid`: unpaid - `pending`: payment in process - `risking`: under risk control - `paid`：paid - `paid_overtime`: payment timeout - `paid_failed`: payment failed * `payment_method` string Payment method. * `processed_at` string Custom date and time for the payment order. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). * `settle_currency` string The currency used by the customer to place the order. The value of this parameter is a three-letter currency code that follow the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. * `settle_pay_amount` double Payment amount in `settle_currency`. The value is rounded to two decimal places. * `status_code` string Payment gateway standard status code. * `status_msg` string The description of `status_code`. * `payment_gateway_names` array Payment method list. Valid values are: - `SLpayments` - `Paypal` - `Oceanpay` - `TwoCheckout` - `AsiaBill` - `Stripe` - `Pacypay` - `WorldPay` - `COD` - `CUSTOM` - `adjustPay` - `Xendit` - `XenditOther` * `payment_terms` object Information related to payment terms. * `created_at` string The date and time when payment terms were created. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). * `due_in_days` integer Remaining days until the payment is due. This field is returned when the value of `payment_terms_type` is `NET`. * `id` string The unique identifier (ID) that identifies this payment term. * `overdue` boolean Whether the payment is overdue. - `true`: overdue - `false`: not overdue * `payment_schedules` array A set of schedules associated with the payment terms. * `completed_at` string Payment completion date and time. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). * `due_at` string Expected payment date and time. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). * `issued_at` string Payment start date and time. When `payment_terms_type` is `FIXED` or `NET`, `issue_at` indicates the save time of the draft order or the order itself. If the draft order is converted to an order, the order inherits the save time of the draft. When `payment_terms_type` is `FULFILLMENT` or `RECEIPT`, it refers to the payment start date and time. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). * `payment_terms_name` string The name of the payment terms template used to create the payment terms. * `payment_terms_type` string The type of payment terms template used to create the payment terms. Valid values are: - `FIXED`: Merchant specified date - `FULFILLMENT`: Fulfillment (Shipment) completion date - `NET`: Fixed condition date - `RECEIPT`: Billing sent date - `UNKNOWN`: Unknown type * `updated_at` string The date and time when the payment term was updated. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). * `phone` string Buyer's mobile phone number. * `po_number` string Purchase order number for a B2B order. * `pos_location_id` string POS trading location ID. * `presentment_currency` string Buyer currency, the same as the store currency. A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. * `processed_at` string Order completion date and time. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). * `processed_user_id` string The ID of the order creator. * `referring_site` string Attribution URL, used to record how the buyer was redirected to the online store. * `refunds` array Refund list. * `created_at` string The date and time when the refund order was created. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). * `id` string Refund ID. * `note` string Refund notes of merchant. * `order_adjustments` array A list of adjusted order information, used to record two types of information: - Refund information related to shipping costs ( `kind` is `shipping_refund` ). - The difference between the automatically calculated refund amount and the actual refund amount ( `kind` is `refund_discrepancy` ). * `amount` string The adjustment order amount. The value is rounded to two decimal places. * `amount_set` object The adjustment order amount, displayed in both the buyer currency and the store currency. * `id` string The adjustment order ID. * `kind` string The adjustment order type. Valid values are: - `refund_discrepancy`: shipping amount adjustment - `shipping_refund`: payment order amount adjustment * `order_id` string Order number. * `reason` string Reason for adjustment. * `refund_id` string The refund order ID. * `tax_amount` string The tax amount of the adjusted order in store currency. The value is rounded to two decimal places. * `tax_amount_set` object The tax amount of the adjustment order, displayed in both the buyer currency and the store currency. * `order_id` string Order number. * `processed_at` string Refund initiation date and time. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). * `refund_line_items` array A list of refund details for each item line. * `id` string Refund order number. * `line_item` object The product line information in the fulfillment order. * `line_item_id` string The ID of the product snapshots table, generated by the system. Combined with the `order.id`, it uniquely identifies a product. * `quantity` integer The quantity of refunded products. * `restock_type` string Inventory return type. Valid values are: - `no_restock`: not returned - `cancel`: canceled - `return`: returned * `subtotal` double The total amount of the refund in the store currency. It is calculated as the product of the unit price and quantity. * `subtotal_set` object The total amount of the refund displayed in both the buyer currency and the store currency. It is calculated as the product of the unit price and quantity. * `total_tax` double The tax amount of the refunded products, displayed in the store currency. The value is rounded to two decimal places. * `total_tax_set` object The tax amount of the refunded products, displayed in both the buyer currency and the store currency. * `transactions` array A list of refund transaction information. * `amount` string The refund amount. The value is rounded to two decimal places. * `channel_refund_id` string A unique identifier for the refund order from the external channel or payment provider. * `created_at` string The date and time when the refund transaction order was created. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). * `currency` string Three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. * `gateway` string Payment channel code. * `id` string Refund ID. * `kind` string Transaction type. The value is fixed to `refund`. * `order_id` string Order number. * `processed_at` string Refund order update date and time. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). * `settle_amount` string Refund amount in the settlement currency ( `settle_currency` ). The value is rounded to two decimal places. * `settle_currency` string Refund settlement currency. The value of this parameter is a three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. * `status` string Refund status. Valid values are: - `pending`: refund in progress - `failure`: refund failed - `success`: refund successful - `error`: refund error * `status_update_at` string Update time of the refund order status. * `user_id` string Buyer ID. * `user_id` string Buyer ID. * `service` string Shipping method type. Valid values are: - `Pickup`: pick up at the store - `null`: other shipping methods * `shipping_address` object The address used for receiving packages. * `address1` string The first line of the address. This typically includes information such as the street address or a post office box number. * `address2` string The second line of the address. This typically includes information such as apartment, suite, or unit number. * `city` string The city in the address. * `company` string The company name of the recipient. * `country` string The country or region in the address. * `country_code` string A two-letter country or region code that follows the [ISO 3166-1](https://www.iso.org/iso-3166-country-codes.html) standard, used to identify a specific country or region in the address. * `delivery_store_code` string Store code for the "Deliver to Store" delivery method in Taiwan. * `delivery_store_name` string Store name for the "Deliver to Store" delivery method in Taiwan. * `district` string The district in the address. * `district_code` string The district code in the address. * `first_name` string The first name of the recipient. * `last_name` string The last name of the recipient. * `latitude` string The latitude where the address is located. * `longitude` string The longitude where the address is located. * `name` string The full name of the recipient. * `phone` string The phone number of the recipient. * `province` string The province in the address. * `province_code` string The code for the province in the address, which can be a custom code or a two-digit [ISO 3166-2](https://www.iso.org/iso-3166-country-codes.html#2012_iso3166-2) international code. * `standard_province_code` string The code for the province in the shipping address, which is a two-digit [ISO 3166-2](https://www.iso.org/iso-3166-country-codes.html#2012_iso3166-2) international code.This differs from `province_code` - the `province_code` response field uses a custom code. * `zip` string The postal code information of the address. * `shipping_lines` array A list of shipping fee. * `code` string Only local delivery shipping methods will return a value, displayed as `Local delivery` . * `discount_allocations` array A list of discount details. * `amount` string The discount amount in store currency. The value is rounded to two decimal places. * `amount_set` object The discount amount, displayed in both the buyer currency and the store currency. * `discount_application_index` integer The position of the discount applied to the product within the `orders.discount_applications` list. * `discounted_price` string Discount amount. The value is rounded to two decimal places, is displayed in the store currency * `discounted_price_set` object The discount amount, displayed in both the buyer currency and the store currency. * `presentment_money` object The discount amount information presented to the buyer. * `shop_money` object The discount amount information recorded by the store. * `phone` string Buyer's phone. * `price` string The shipping fee amount in store currency. The value is rounded to two decimal places. * `price_set` object The shipping fee amount, displayed in both the buyer currency and the store currency. * `presentment_money` object The shipping fee information presented to the buyer. * `shop_money` object The shipping fee information recorded by the store. * `requested_fulfillment_service_id` string Transportation service code. * `shipping_price` string The original shipping fee in store currency, excluding the amount after discount. The value is rounded to two decimal places. * `shipping_price_set` object The original shipping fee, excluding the amount after discount, displayed in both the buyer currency and the store currency. * `presentment_money` object The shipping fee information presented to the buyer. * `shop_money` object The shipping fee information recorded by the store. * `shipping_strategy_name` string The name of the shipping strategy. It has a corresponding value only when the shipping method is `SHIPPING` or `LOCAL_DELIVERY`. * `source` string Logistics carrier type. Valid values are: - `Shipper`: Shipper logistics - `Oneship`: Oneship logistics - `Api`: logistics carriers added via open API capabilities - `null`: system logistics or custom logistics * `tax_lines` array A list of logistics tax information. * `price` string Tax in store currency. The value is rounded to two decimal places. * `price_set` object The tax amount, displayed in both the buyer currency and the store currency. * `rate` double The tax rate as a decimal value, rounded to four decimal places. For example, a 2% tax rate is represented as `0.0200`. This field value is for display only. * `title` string The title for the tax description, for display only. * `title` string Logistics company name. * `source_identifier` string The marketing referral code carried by the store link through which the customer accesses the store. The field value is extracted from the URL parameter `ref`, `resource`, or `r`. For example, if the customer visits the URL `myshopline.com/products/slide?ref=22dd9dctg`, then the value of this field is `22dd9dctg`. * `source_name` string Indicates the category of the app that initiated this API. Valid values are: - `sales_plugin_of`: The distribution app in the marketing system - `member_plugin_referral`: The referral app in the membership system * `source_url` string Attribution URL, used to record how the buyer was redirected to the online store. * `status` string Order status. Valid values are： - `open`: The order is processing. - `canceled`: The order is cancelled. * `store_id` string Store ID. * `subtotal_price` string The final price after discounts, calculated as the total product price minus any marketing discounts and custom discounts. The amount is displayed in the store currency. * `subtotal_price_set` object The final price after discounts, calculated as the total product price minus any marketing discounts and custom discounts. This field contains amounts displayed in both the buyer and store currencies. * `presentment_money` object The final price information presented to the buyer. * `amount` string The final price. The value is rounded to two decimal places. * `currency_code` string A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. * `shop_money` object The final price information recorded by the store. * `amount` string The final price. The value is rounded to two decimal places. * `currency_code` string A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. * `tags` string Order tag. * `tax_description` string The description for the tax. * `tax_lines` array A list of tax information. * `name` string Tax name. * `price` string Tax in store currency. The value is rounded to two decimal places. * `price_set` object The tax amount, displayed in both the buyer currency and the store currency. * `presentment_money` object The tax amount information presented to the buyer. * `shop_money` object The tax amount information recorded by the store. * `rate` double The tax rate as a decimal value, rounded to four decimal places. For example, a 2% tax rate is represented as `0.0200`. This field value is for display only. * `title` string The title for the tax description, for display only. * `tax_number` string Tax ID. * `tax_type` string The type of tax applicable to the order. Valid values are: - `product_tax`: product tax - `shipping_tax`: shipping tax * `taxes_included` boolean Indicates whether this order includes taxes. - `true`: including taxes - `false`: excluding taxes * `total_discounts` string The total order discount, calculated as the sum of marketing discounts and custom discounts. The amount is rounded to two decimal places and displayed in the store currency. :::danger **DEPRECATED**：This parameter is deprecated from API version v20210901. ::: * `total_discounts_set` object The total order discount, calculated as the sum of marketing discounts and custom discounts. This field contains amounts displayed in both the buyer and store currencies. :::danger **DEPRECATED**：This parameter is deprecated from API version v20210901. ::: * `presentment_money` object The discount amount information presented to the buyer. * `amount` string The discount amount. The value is rounded to two decimal places. * `currency_code` string A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. * `shop_money` object The discount amount information recorded by the store. * `amount` string The discount amount. The value is rounded to two decimal places. * `currency_code` string A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. * `total_line_items_price` string The total original price of the products, rounded to two decimal places, displayed in the store currency. * `total_line_items_price_set` object The total original price of the products, displayed in both the buyer currency and the store currency. * `presentment_money` object The original price information presented to the buyer. * `amount` string The original price. The value is rounded to two decimal places. * `currency_code` string A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. * `shop_money` object The original price information recorded by the store. * `amount` string The original price. The value is rounded to two decimal places. * `currency_code` string A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. * `total_outstanding` string The total unpaid amount in the store currency. The value is rounded to two decimal places. * `total_shipping_price_set` object The total shipping fee for the order, displayed in both the buyer currency and the store currency. * `presentment_money` object The shipping fee information presented to the buyer. * `amount` string The shipping fee. The value is rounded to two decimal places. * `currency_code` string A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. * `shop_money` object The shipping fee information recorded by the store. * `amount` string The shipping fee. The value is rounded to two decimal places. * `currency_code` string A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. * `total_tax` string The total tax amount in the store currency. The value is rounded to two decimal places. * `total_tax_set` object The total tax amount, displayed in both the buyer currency and the store currency. * `presentment_money` object The tax amount information presented to the buyer. * `amount` string The tax amount. The value is rounded to two decimal places. * `currency_code` string A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. * `shop_money` object The tax amount information recorded by the store. * `amount` string The tax amount. The value is rounded to two decimal places. * `currency_code` string A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. * `total_tip_received` string The tip amount in the store currency. The value is rounded to two decimal places. * `total_tip_received_set` object The tip amount, displayed in both the store currency and the buyer currency. * `presentment_money` object The tip amount information presented to the buyer. * `amount` string The tip amount. The value is rounded to two decimal places. * `currency_code` string A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. * `shop_money` object The tip amount information recorded by the store. * `amount` string The tip amount. The value is rounded to two decimal places. * `currency_code` string A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. * `total_weight` double The total weight of products in grams(g). * `updated_at` string The date and time when the order was updated. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). * `user_id` string Buyer ID. * `utm_parameters` string Parameters specifically designed for the advertising business, used for ad attribution calculation. :::danger **DEPRECATED**：This parameter is deprecated from API version v20251201. Please fetch data from the [Get order attribution in bulk](https://developer.shopline.com/docs/admin-rest-api/order/order-management/get-order-attribution-in-bulk.md) API. ::: #### 401 * `errors` string Error message. #### 429 * `errors` string Error message. ## OpenAPI Definition ```json { "tags": [ "Get orders" ], "description": "Get order details in bulk based on specified request information. For example, you can get orders by the order creation time or update time, or specify an order ID to get details for a single order. ", "externalDocs": { "description": "Permission point used by the interface is `read_orders` , For more information about the use of permission points, see", "url": "ec20/3cv5d7wpfgr6a8z5/xabczf5442284vkq?lang=en", "errorTableDescription": "| Error Code | HTTP Status Code | Error Description |\n|------------|------------------|-------------------|\n| INTERNAL_ERROR | 500 | An internal error occured. |\n| SUCCESS | 200 | request success |\n| PARAM_ILLEGAL | 422 | illegal param |\n| ILLEGAL_PARAMS | 422 | illegal param |\n| ORDER_AT_END_TIME_AFTER_START | 400 | The \"order_at_max\" must be later than \"order_at_min\". |\n" }, "operationId": "jyjIsvq9", "parameters": [ { "name": "created_at_min", "in": "query", "description": "Specify the start date and time for filtering orders by order creation time. The system returns orders created at and after this time. Format：[ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).", "style": "form", "explode": true, "schema": { "name": "created_at_min", "description": "Specify the start date and time for filtering orders by order creation time. The system returns orders created at and after this time. Format：[ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).", "type": "string", "example": "2021-08-04T23:59:59+08:00" }, "example": "2021-08-04T23:59:59+08:00", "examples": { "Get orders": { "value": "" } } }, { "name": "financial_status", "in": "query", "description": "The payment status of the order. Valid values are: \n- `unpaid`: order not paid\n- `authorized`: order payment has been authorized\n- `pending`: order payment in progress\n- `partially_paid`: order partially paid\n- `paid`: order paid\n- `partially_refunded`: order partially refunded\n- `refunded`: order fully refunded", "style": "form", "explode": true, "schema": { "name": "financial_status", "description": "The payment status of the order. Valid values are: \n- `unpaid`: order not paid\n- `authorized`: order payment has been authorized\n- `pending`: order payment in progress\n- `partially_paid`: order partially paid\n- `paid`: order paid\n- `partially_refunded`: order partially refunded\n- `refunded`: order fully refunded", "type": "string" }, "examples": { "Get orders": { "value": "" } } }, { "name": "order_at_max", "in": "query", "description": "Specify the end date and time for filtering orders by order time. The system returns orders placed at this time and up to 1 year prior. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).", "style": "form", "explode": true, "schema": { "name": "order_at_max", "description": "Specify the end date and time for filtering orders by order time. The system returns orders placed at this time and up to 1 year prior. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).", "type": "string", "example": "2026-07-17T15:00:00Z" }, "example": "2026-07-17T15:00:00Z", "examples": { "Get orders": { "value": "" } } }, { "name": "order_at_min", "in": "query", "description": "Specify the start date and time for filtering orders by order time. The system returns orders placed at this time and up to 1 year after. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).", "style": "form", "explode": true, "schema": { "name": "order_at_min", "description": "Specify the start date and time for filtering orders by order time. The system returns orders placed at this time and up to 1 year after. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).", "type": "string", "example": "2026-07-17T15:00:00Z" }, "example": "2026-07-17T15:00:00Z", "examples": { "Get orders": { "value": "" } } }, { "name": "page_info", "in": "query", "description": "The unique identifier for pagination queries, used to locate a specific page. \n\nThis parameter value is obtained from the `link` value in the response header of this API after you have queried the pagination information. \n\nFor example, if the `link` value you obtained is `; rel=\"next\"` , the value of `page_info` is `eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9` . \n\nFor more information on how to use pagination, refer to [Paging Mechanism](https://developer.shopline.com/docs/apps/api-instructions-for-use/paging-mechanism.md).", "style": "form", "explode": true, "schema": { "name": "page_info", "description": "The unique identifier for pagination queries, used to locate specific pages.\n\nThis parameter value is obtained from the `link` value in the response header of this APl after you have queried the pagination information.\n\nFor example, if the `link` value you obtained is `; rel=\"next\"` then the value of `page_info` is `eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9`.\n\nFor more information on how to use\npagination, refer to [Paging Mechanism](https://developer.shopline.com/docs/apps/api-instructions-for-use/paging-mechanism.md).", "type": "string" }, "examples": { "Get orders": { "value": "" } } }, { "name": "updated_at_min", "in": "query", "description": "Specify the start date and time for filtering orders by order update time. The system returns orders updated at and after this time. \nFormat：[ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).", "style": "form", "explode": true, "schema": { "name": "updated_at_min", "description": "Specify the start date and time for filtering orders by order update time. The system returns orders updated at and after this time. \nFormat：[ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).", "type": "string", "example": "2021-08-04T23:59:59+08:00" }, "example": "2021-08-04T23:59:59+08:00", "examples": { "Get orders": { "value": "" } } }, { "name": "created_at_max", "in": "query", "description": "Specify the end date and time for filtering orders by order creation time. The system returns orders created at and before this time. Format：[ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).", "style": "form", "explode": true, "schema": { "name": "created_at_max", "description": "Specify the end date and time for filtering orders by order creation time. The system returns orders created at and before this time. Format：[ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).", "type": "string", "example": "2021-08-18T23:59:59+08:00" }, "example": "2021-08-18T23:59:59+08:00", "examples": { "Get orders": { "value": "2024-10-10T12:00:00+08:00" } } }, { "name": "fulfillment_status", "in": "query", "description": "The shipment status of the order. Valid values are: \n- `unshipped`: order not shipped\n- `partial`: order partially shipped\n- `shipped`: order shipped\n\nDefault value: `unshipped`\n\n:::warning\n**Caution**: The accuracy of the inputted value will be strictly validated. If the value fails validation, the order query will fail and an error `fulfillment status value is illegal` will be triggered. \n:::", "style": "form", "explode": true, "schema": { "name": "fulfillment_status", "description": "The shipment status of the order. Valid values are: \n- `unshipped`: order not shipped\n- `partial`: order partially shipped\n- `shipped`: order shipped\n\nDefault value: `unshipped`\n\n:::warning\n**Caution**: The accuracy of the inputted value will be strictly validated. If the value fails validation, the order query will fail and an error `fulfillment status value is illegal` will be triggered. \n:::", "type": "string" }, "examples": { "Get orders": { "value": "" } } }, { "name": "ids", "in": "query", "description": "Order IDs, separated by commas. Up to a maximum of 100 IDs. ", "style": "form", "explode": true, "schema": { "name": "ids", "description": "Order IDs, separated by commas. Up to a maximum of 100 IDs. ", "type": "string", "example": "21050224312121887324667162, 21050224312121887324667164" }, "example": "21050224312121887324667162, 21050224312121887324667164", "examples": { "Get orders": { "value": "" } } }, { "name": "location", "in": "query", "description": "The ID of the location where the products in the order are fulfilled, or the POS transaction point ID. You can specify multiple location IDs by separating them with commas.", "style": "form", "explode": true, "schema": { "name": "location", "description": "The ID of the location where the products in the order are fulfilled, or the POS transaction point ID. You can specify multiple location IDs by separating them with commas.", "type": "string", "example": "5453386037065169090, 5564834083287605454" }, "example": "5453386037065169090, 5564834083287605454", "examples": { "Get orders": { "value": "" } } }, { "name": "search_content", "in": "query", "description": "Search content, such as order number, payment serial number, express delivery number, product name, product SKU number, and order amount.", "style": "form", "explode": true, "schema": { "name": "search_content", "description": "Search content, such as order number, payment serial number, express delivery number, product name, product SKU number, and order amount.", "type": "string", "example": "D203" }, "example": "D203", "examples": { "Get orders": { "value": "" } } }, { "name": "sort_condition", "in": "query", "description": "Specify the sorting conditions for order results. You can sort by fields `order_at` (order creating time) or `id` (order ID), and each field can be specified as either `asc`(ascending) or `desc`(descending). Use commas to separate multiple sorting conditions. \n\nFor example, if you specify the value of this field as `order_at:desc, id:asc`, order results will first be sorted in descending order by order creation time, then in ascending order by order ID.", "style": "form", "explode": true, "schema": { "name": "sort_condition", "description": "Specify the sorting conditions for order results. You can sort by fields `order_at` (order creating time) or `id` (order ID), and each field can be specified as either `asc`(ascending) or `desc`(descending). Use commas to separate multiple sorting conditions. \n\nFor example, if you specify the value of this field as `order_at:desc, id:asc`, order results will first be sorted in descending order by order creation time, then in ascending order by order ID.", "type": "string", "example": "order_at:desc" }, "example": "order_at:desc", "examples": { "Get orders": { "value": "" } } }, { "name": "contract_ids", "in": "query", "description": "Subscription contract IDs. You can specify multiple IDs by separating them with commas, up to a maximum of 50 IDs.", "style": "form", "explode": true, "schema": { "name": "contract_ids", "description": "Subscription contract IDs. You can specify multiple IDs by separating them with commas, up to a maximum of 50 IDs.", "type": "string", "example": "3005619945158043247856" }, "example": "3005619945158043247856", "examples": { "Get orders": { "value": "" } } }, { "name": "email", "in": "query", "description": "Email of the buyer who placed the order.", "style": "form", "explode": true, "schema": { "name": "email", "description": "Email of the buyer who placed the order.", "type": "string", "example": "Washingtontest@gmail.com" }, "example": "Washingtontest@gmail.com", "examples": { "Get orders": { "value": "" } } }, { "name": "limit", "in": "query", "description": "The maximum number of orders to return per request. Valid values range from `1` to `100`. The default value is `20`.", "style": "form", "explode": true, "schema": { "name": "limit", "description": "The maximum number of orders to return per request. Valid values range from `1` to `100`. The default value is `20`.", "type": "string" }, "examples": { "Get orders": { "value": "" } } }, { "name": "name", "in": "query", "description": "Order number. Different from the order ID, this number can have a custom prefix set in the SHOPLINE Admin. ", "style": "form", "explode": true, "schema": { "name": "name", "description": "Order number. Different from the order ID, this number can have a custom prefix set in the SHOPLINE Admin. ", "type": "string", "example": "D2034" }, "example": "D2034", "examples": { "Get orders": { "value": "" } } }, { "name": "since_id", "in": "query", "description": "The starting position of the order number ID of the data to be queried.", "style": "form", "explode": true, "schema": { "name": "since_id", "description": "The starting position of the order number ID of the data to be queried.", "type": "string", "example": "21056199447626881527947685" }, "example": "21056199447626881527947685", "examples": { "Get orders": { "value": "" } } }, { "name": "buyer_id", "in": "query", "description": "The ID of the buyer who placed the order. ", "style": "form", "explode": true, "schema": { "name": "buyer_id", "description": "The ID of the buyer who placed the order. ", "type": "string", "example": "4201057495" }, "example": "4201057495", "examples": { "Get orders": { "value": "" } } }, { "name": "fields", "in": "query", "description": "Specify the fields to query, separated by commas. If not specified, all field information is returned.", "style": "form", "explode": true, "schema": { "name": "fields", "description": "Specify the fields to query, separated by commas. If not specified, all field information is returned.", "type": "string", "example": "id,email,note" }, "example": "id,email,note", "examples": { "Get orders": { "value": "" } } }, { "name": "hidden_order", "in": "query", "description": "Whether orders to query are archived. \n- `true`: The orders are archived.\n- `false`: The orders are not archived.\n\nDefault value: `false`", "style": "form", "explode": true, "schema": { "name": "hidden_order", "description": "Whether orders to query are archived. \n- `true`: The orders are archived.\n- `false`: The orders are not archived.\n\nDefault value: `false`", "type": "string" }, "examples": { "Get orders": { "value": "" } } }, { "name": "status", "in": "query", "description": "Order status. Valid values are:\n- `open`: order in process\n- `cancelled`: order canceled\n- `any`: contains many other statues, such as order archived", "style": "form", "explode": true, "schema": { "name": "status", "description": "Order status. Valid values are:\n- `open`: order in process\n- `cancelled`: order canceled\n- `any`: contains many other statues, such as order archived", "type": "string" }, "examples": { "Get orders": { "value": "cancelled" } } }, { "name": "updated_at_max", "in": "query", "description": "Specify the end date and time for filtering orders by order update time. The system returns orders updated at and before this time. Format：[ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).", "style": "form", "explode": true, "schema": { "name": "updated_at_max", "description": "Specify the end date and time for filtering orders by order update time. The system returns orders updated at and before this time. Format：[ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).", "type": "string", "example": "2021-08-18T23:59:59+08:00" }, "example": "2021-08-18T23:59:59+08:00", "examples": { "Get orders": { "value": "" } } }, { "name": "Content-Type", "in": "header", "description": "The field must be set to the fixed value `application/json; charset=utf-8`.", "required": true, "schema": { "name": "Content-Type", "type": "string", "example": "application/json; charset=utf-8" } }, { "name": "Authorization", "in": "header", "description": " The access token for the API resource. Refer to [App authorization](https://developer.shopline.com/docs/apps/api-instructions-for-use/app-authorization.md?lang=en) to obtain the access token, and then pass the obtained token in the Bearer format. ", "required": true, "style": "string", "schema": { "name": "Authorization", "description": " The access token for the API resource. Refer to [App authorization](https://developer.shopline.com/docs/apps/api-instructions-for-use/app-authorization.md?lang=en) to obtain the access token, and then pass the obtained token in the Bearer format. ", "type": "string", "example": "Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA" }, "example": "Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA" } ], "responses": { "200": { "description": "For the complete list of codes and messages, see [Http status code](https://developer.shopline.com/docs/apps/api-instructions-for-use/http-status-code.md?lang=en).", "headers": { "link": { "description": "The URL link that provides the pagination data. You can obtain `page_info` from this parameter for subsequent pagination requests. \n\nThis parameter is returned when the requested page has a previous or next page. \n\nFor more information on how to use pagination, refer to [Paging Mechanism](https://developer.shopline.com/docs/apps/api-instructions-for-use/paging-mechanism.md).", "example": "\\; rel='previous',; rel='next'" }, "traceId": { "description": "A globally unique identifier for the request. It is used to track the request flow throughout the system, allowing for easy location and debugging when issues arise." } }, "content": { "application/json": { "schema": { "name": "body", "type": "object", "properties": { "orders": { "name": "orders", "description": "List of order details. ", "type": "array", "items": { "type": "object", "properties": { "adjust_price": { "name": "adjust_price", "description": "The amount discrepancy due to rounding adjustments in POS transactions, expressed in the store currency. ", "type": "string", "example": "8.00" }, "adjust_price_set": { "name": "adjust_price_set", "description": "The amount discrepancy due to rounding adjustments in POS transactions, displayed in both the buyer currency and the store currency. ", "type": "object", "properties": { "presentment_money": { "name": "presentment_money", "description": "The amount discrepancy information presented to the buyer.", "type": "object", "properties": { "amount": { "name": "amount", "description": "The adjusted price amount. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard.", "type": "string", "example": "USD" } }, "example": { "amount": "8.00", "currency_code": "USD" } }, "shop_money": { "name": "shop_money", "description": "The amount discrepancy information recorded by the store.", "type": "object", "properties": { "amount": { "name": "amount", "description": "The adjusted price amount. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" } }, "example": { "amount": "8.00", "currency_code": "USD" } } }, "example": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } } }, "billing_address": { "name": "billing_address", "description": "The address for sending billing invoices. ", "type": "object", "properties": { "address1": { "name": "address1", "description": "The first line of the address. This typically includes information such as the street address or a post office box number.", "type": "string", "example": "Address 1" }, "address2": { "name": "address2", "description": "The second line of the address. This typically includes information such as apartment, suite, or unit number. ", "type": "string", "example": "Address 2" }, "city": { "name": "city", "description": "The city in the address. ", "type": "string", "example": "New York" }, "company": { "name": "company", "description": "The company name of the billing recipient. ", "type": "string", "example": "New company name" }, "country": { "name": "country", "description": "The country or region in the address. ", "type": "string", "example": "USA" }, "country_code": { "name": "country_code", "description": "A two-letter country or region code that follows the [ISO 3166-1](https://www.iso.org/iso-3166-country-codes.html) standard, used to identify a specific country or region in the address. ", "type": "string", "example": "US" }, "first_name": { "name": "first_name", "description": "The first name of the billing recipient.", "type": "string", "example": "Tom" }, "last_name": { "name": "last_name", "description": "The last name of the billing recipient. ", "type": "string", "example": "Washington" }, "name": { "name": "name", "description": "The full name of the billing recipient.", "type": "string", "example": "test1001" }, "phone": { "name": "phone", "description": "The phone number of the billing recipient. ", "type": "string", "example": "13100000000" }, "province": { "name": "province", "description": "The province in the address. ", "type": "string", "example": "California" }, "province_code": { "name": "province_code", "description": "The code for the province in the billing address, which can be a custom code or a two-digit [ISO 3166-2](https://www.iso.org/iso-3166-country-codes.html#2012_iso3166-2) international code.", "type": "string", "example": "4200006" }, "standard_province_code": { "name": "standard_province_code", "description": "The code for the province in the billing address, which is a two-digit [ISO 3166-2](https://www.iso.org/iso-3166-country-codes.html#2012_iso3166-2) international code.This differs from `province_code` - the `province_code` response field uses a custom code.", "type": "string" }, "zip": { "name": "zip", "description": "The postal code information of the address. ", "type": "string", "example": "92503" } }, "example": { "address1": "Address 1", "address2": "Address 2", "city": "New York", "company": "New company name", "country": "USA", "country_code": "US", "first_name": "Tom", "last_name": "Washington", "name": "test1001", "phone": "13100000000", "province": "California", "province_code": "4200006", "standard_province_code": null, "zip": "92503" } }, "browser_ip": { "name": "browser_ip", "description": "The client IP address captured when the buyer places an order.", "type": "string", "example": "157.119.232.35" }, "buyer_note": { "name": "buyer_note", "description": "Buyer's message.", "type": "string", "example": "message" }, "cancel_reason": { "name": "cancel_reason", "description": "Merchant's reason for cancellation.", "type": "string", "example": "I don't want to buy it." }, "cancelled_at": { "name": "cancelled_at", "description": "The date and time when the order was canceled.\nFormat: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).", "type": "string", "example": "2012-05-01T14:22:25-04:00" }, "cart_token": { "name": "cart_token", "description": "The unique identifier for shopping cart data.", "type": "string", "example": "c2c4a58186b9d96395d7e6b5c2969577" }, "checkout_id": { "name": "checkout_id", "description": "Abandoned order ID.", "type": "string", "example": "2404785166526352972864" }, "checkout_token": { "name": "checkout_token", "description": "The unique identifier for abandoned order data. After a customer initiates the checkout process, an abandoned order is generated. ", "type": "string", "example": "c2c4a58186b9d96395d7e6b5c2969577" }, "client_details": { "name": "client_details", "description": "Client details.", "type": "object", "properties": { "browser_ip": { "name": "browser_ip", "description": "The client IP address captured when the buyer places an order.", "type": "string", "example": "157.119.232.35" }, "session_hash": { "name": "session_hash", "description": "Member session encrypted information.", "type": "string", "example": "c2c4a58186b9d96395d7e6b5c2969577" }, "user_agent": { "name": "user_agent", "description": "User agent.", "type": "string", "example": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/106.0.0.0 Safari/537.36" } }, "example": { "browser_ip": "157.119.232.35", "session_hash": "c2c4a58186b9d96395d7e6b5c2969577", "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/106.0.0.0 Safari/537.36" } }, "company": { "name": "company", "description": "The buyer's company information as recorded at the time the order was placed.", "type": "object", "properties": { "id": { "name": "id", "description": "Company ID.", "type": "string", "example": "1005619945158043247856" }, "location_id": { "name": "location_id", "description": "Location ID.", "type": "string", "example": "3005619945158043247856" }, "tax_registration_id": { "name": "tax_registration_id", "description": "Tax registration ID.", "type": "string", "example": "213213" } }, "example": { "id": "1005619945158043247856", "location_id": "3005619945158043247856", "tax_registration_id": "213213" } }, "contract_seq": { "name": "contract_seq", "description": "Subscription contract ID.", "type": "string", "example": "3005619945158043247856" }, "created_at": { "name": "created_at", "description": "The date and time when the order was created. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).", "type": "string", "example": "2021-08-16T08:27:57+00:00" }, "credit_limit": { "name": "credit_limit", "description": "Payment information (credit limit). ", "type": "object", "properties": { "credit_limit_currency": { "name": "credit_limit_currency", "description": "The currency of the credit payment, same as the store currency. The value of this parameter is a three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" }, "is_credit_limit": { "name": "is_credit_limit", "description": "Whether the order was paid using the credit limit (payment terms).\n- `true`: used\n- `false`: not used", "type": "boolean" }, "outstanding_credit_limit": { "name": "outstanding_credit_limit", "description": "The current outstanding credit limit total for the order. This value decreases as the buyer makes payments toward the order.", "type": "string", "example": "1.00" }, "total_credit_limit": { "name": "total_credit_limit", "description": "The initial credit limit total used for the order (equal to the initial outstanding credit limit total).", "type": "string", "example": "1.00" } }, "example": { "credit_limit_currency": "USD", "is_credit_limit": null, "outstanding_credit_limit": "1.00", "total_credit_limit": "1.00" } }, "currency": { "name": "currency", "description": "Transaction currency. A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" }, "current_subtotal_price": { "name": "current_subtotal_price", "description": "The total amount of products, calculated by multiplying the unit price by the quantity and displayed in the store currency.", "type": "string", "example": "78.0" }, "current_subtotal_price_set": { "name": "current_subtotal_price_set", "description": "The total amount of products, calculated by multiplying the unit price by the quantity and displayed in both the buyer currency and the store currency.", "type": "object", "properties": { "presentment_money": { "name": "presentment_money", "description": "The order price information presented to the buyer. ", "type": "object", "properties": { "amount": { "name": "amount", "description": "The order amount. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" } }, "example": { "amount": "8.00", "currency_code": "USD" } }, "shop_money": { "name": "shop_money", "description": "The order price information recorded by the store.", "type": "object", "properties": { "amount": { "name": "amount", "description": "The order amount. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" } }, "example": { "amount": "8.00", "currency_code": "USD" } } }, "example": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } } }, "current_total_discounts": { "name": "current_total_discounts", "description": "The total discount amount in the store currency. It is calculated by adding marketing discounts and custom discounts, with the resulting amount rounded to two decimal places.", "type": "string", "example": "1.00" }, "current_total_discounts_set": { "name": "current_total_discounts_set", "description": "The total discount amount displayed in both the buyer currency and the store currency. It is calculated by adding marketing discounts and custom discounts, with the resulting amount rounded to two decimal places.", "type": "object", "properties": { "presentment_money": { "name": "presentment_money", "description": "The total discount amount information presented to the buyer. ", "type": "object", "properties": { "amount": { "name": "amount", "description": "The total discount amount. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard.", "type": "string", "example": "USD" } }, "example": { "amount": "8.00", "currency_code": "USD" } }, "shop_money": { "name": "shop_money", "description": "The total discount amount information recorded by the store.", "type": "object", "properties": { "amount": { "name": "amount", "description": "The total discount amount. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard.", "type": "string", "example": "USD" } }, "example": { "amount": "8.00", "currency_code": "USD" } } }, "example": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } } }, "current_total_duties_set": { "name": "current_total_duties_set", "description": "The total customs duties for the products, displayed in both the buyer currency and the store currency.", "type": "object", "properties": { "presentment_money": { "name": "presentment_money", "description": "The total customs duties information for the products presented to the buyer. ", "type": "object", "properties": { "amount": { "name": "amount", "description": "The duty amount. The value is rounded to two decimal places. ", "type": "string", "example": "8.88" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard.", "type": "string", "example": "USD" } }, "example": { "amount": "8.88", "currency_code": "USD" } }, "shop_money": { "name": "shop_money", "description": "The total customs duties information for the products recorded by the store.", "type": "object", "properties": { "amount": { "name": "amount", "description": "The duty amount. The value is rounded to two decimal places. ", "type": "string", "example": "8.88" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" } }, "example": { "amount": "8.88", "currency_code": "USD" } } }, "example": { "presentment_money": { "amount": "8.88", "currency_code": "USD" }, "shop_money": { "amount": "8.88", "currency_code": "USD" } } }, "current_total_price": { "name": "current_total_price", "description": "The total order amount, displayed in the store currency.", "type": "string", "example": "60.0" }, "current_total_price_set": { "name": "current_total_price_set", "description": "The total order amount, displayed in both the buyer currency and the store currency.", "type": "object", "properties": { "presentment_money": { "name": "presentment_money", "description": "The order price information presented to the buyer. ", "type": "object", "properties": { "amount": { "name": "amount", "description": "The total order amount. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" } }, "example": { "amount": "8.00", "currency_code": "USD" } }, "shop_money": { "name": "shop_money", "description": "The order price information recorded by the store.", "type": "object", "properties": { "amount": { "name": "amount", "description": "The total order amount. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard.", "type": "string", "example": "USD" } }, "example": { "amount": "8.00", "currency_code": "USD" } } }, "example": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } } }, "current_total_tax": { "name": "current_total_tax", "description": "The total tax amount, displayed in the store currency.", "type": "string", "example": "1.00" }, "current_total_tax_set": { "name": "current_total_tax_set", "description": "The total tax amount, displayed in both the buyer currency and the store currency.", "type": "object", "properties": { "presentment_money": { "name": "presentment_money", "description": "The tax information presented to the buyer. ", "type": "object", "properties": { "amount": { "name": "amount", "description": "The tax amount. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" } }, "example": { "amount": "8.00", "currency_code": "USD" } }, "shop_money": { "name": "shop_money", "description": "The tax information recorded by the store.", "type": "object", "properties": { "amount": { "name": "amount", "description": "The tax amount. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" } }, "example": { "amount": "8.00", "currency_code": "USD" } } }, "example": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } } }, "customer": { "name": "customer", "description": "Buyer information.", "type": "object", "properties": { "addresses": { "name": "addresses", "description": "Buyer's address information.", "type": "object", "properties": { "address1": { "name": "address1", "description": "The first line of the address. This typically includes information such as the street address or a post office box number.", "type": "string", "example": "Wanda" }, "address2": { "name": "address2", "description": "The second line of the address. This typically includes information such as apartment, suite, or unit number.", "type": "string", "example": "65788" }, "city": { "name": "city", "description": "The city in the address. ", "type": "string", "example": "Yangquan City" }, "country": { "name": "country", "description": "The country or region in the address.", "type": "string", "example": "China" }, "country_code": { "name": "country_code", "description": "A two-letter country or region code that follows the [ISO 3166-1](https://www.iso.org/iso-3166-country-codes.html) standard, used to identify a specific country or region in the address. ", "type": "string", "example": "US" }, "first_name": { "name": "first_name", "description": "The first name of the recipient.", "type": "string", "example": "Tom" }, "last_name": { "name": "last_name", "description": "The last name of the recipient.", "type": "string", "example": "Washington" }, "name": { "name": "name", "description": "The full name of the recipient.", "type": "string", "example": "D203" }, "phone": { "name": "phone", "description": "The phone number of the buyer. ", "type": "string", "example": "13100000000" }, "province": { "name": "province", "description": "The province in the address. ", "type": "string", "example": "Shanxi Province" }, "province_code": { "name": "province_code", "description": "The code for the province in the billing address, which can be a custom code or a two-digit [ISO 3166-2](https://www.iso.org/iso-3166-country-codes.html#2012_iso3166-2) international code.", "type": "string", "example": "ASD" }, "zip": { "name": "zip", "description": "The postal code information of the address.", "type": "string", "example": "521000" } }, "example": { "address1": "Wanda", "address2": "65788", "city": "Yangquan City", "country": "China", "country_code": "US", "first_name": "Tom", "last_name": "Washington", "name": "D203", "phone": "13100000000", "province": "Shanxi Province", "province_code": "ASD", "zip": "521000" } }, "area_code": { "name": "area_code", "description": "The area or country code for the phone number. ", "type": "string", "example": "+86" }, "created_at": { "name": "created_at", "description": "The date and time when the buyer information was created. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).", "type": "string", "example": "2024-08-31T02:20:26+08:00" }, "currency": { "name": "currency", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" }, "email": { "name": "email", "description": "The email of the buyer. ", "type": "string", "example": "Washingtontest@gmail.com" }, "first_name": { "name": "first_name", "description": "The first name of the buyer.", "type": "string", "example": "Tom" }, "id": { "name": "id", "description": "Buyer's ID.", "type": "string", "example": "4201057495" }, "last_name": { "name": "last_name", "description": "The last name of the buyer.", "type": "string", "example": "Washington" }, "phone": { "name": "phone", "description": "The phone number of the buyer. ", "type": "string", "example": "13100000000" }, "updated_at": { "name": "updated_at", "description": "The date and time when the buyer's information was updated. Format：[ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).", "type": "string", "example": "2022-11-04T10:18:46+00:00" } }, "example": { "addresses": { "address1": "Wanda", "address2": "65788", "city": "Yangquan City", "country": "China", "country_code": "US", "first_name": "Tom", "last_name": "Washington", "name": "D203", "phone": "13100000000", "province": "Shanxi Province", "province_code": "ASD", "zip": "521000" }, "area_code": "+86", "created_at": "2024-08-31T02:20:26+08:00", "currency": "USD", "email": "Washingtontest@gmail.com", "first_name": "Tom", "id": "4201057495", "last_name": "Washington", "phone": "13100000000", "updated_at": "2022-11-04T10:18:46+00:00" } }, "customer_locale": { "name": "customer_locale", "description": "Buyer's language code + country or region code. \nThe language code follows the [ISO 639](https://www.iso.org/iso-639-language-code) standard. Country or region code follows the [ISO 3166-1](https://www.iso.org/glossary-for-iso-3166.html) standard.", "type": "string", "example": "enCA" }, "deduct_member_point_amount": { "name": "deduct_member_point_amount", "description": "The amount deducted from the order using member points, expressed in the store currency and rounded to two decimal places. ", "type": "string", "example": "8.00" }, "deduct_member_point_amount_set": { "name": "deduct_member_point_amount_set", "description": "The amount deducted from the order using member points, displayed in both the buyer currency and the store currency.", "type": "object", "properties": { "presentment_money": { "name": "presentment_money", "description": "The deduction amount information presented to the buyer. ", "type": "object", "properties": { "amount": { "name": "amount", "description": "The deduction amount. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard.", "type": "string", "example": "USD" } }, "example": { "amount": "8.00", "currency_code": "USD" } }, "shop_money": { "name": "shop_money", "description": "The deduction amount information recorded by the store.", "type": "object", "properties": { "amount": { "name": "amount", "description": "The deduction amount. The value is rounded to two decimal places. ", "type": "string", "example": "1.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard.", "type": "string", "example": "USD" } }, "example": { "amount": "1.00", "currency_code": "USD" } } }, "example": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "1.00", "currency_code": "USD" } } }, "discount_applications": { "name": "discount_applications", "description": "A list of discount information. ", "type": "array", "items": { "type": "object", "properties": { "activity_type": { "name": "activity_type", "description": "The type of promotion applied to the product line:\n\n- `0`: Flash Sale\n- `1`: Time-Limited Promotion\n- `2`: Bundle Offer\n- `3`: Discount Code\n- `4`: One-Page Store\n- `5`: Free Gift\n- `6`: Pre-Order\n- `7`: Add-On Item\n- `8`: Gift Box\n- `9`: Product Upsell Campaign", "type": "integer" }, "allocation_method": { "name": "allocation_method", "description": "The discount scope. Valid values are:\n- `across`: The discount is applied to the total product amount. \n- `each`: The discount is applied to each product individually. \n\nExample: Assume the store currency is CNY. For the purchase of three identical items with a discount amount of 10 CNY, if `allocation_method` is `across`, the total price of the three items is reduced by 10 CNY; if `allocation_method` is `each`, the price of each item is reduced by 10 CNY.", "type": "string" }, "benefit_type": { "name": "benefit_type", "description": "The type of discount applied to the product line:\n\n- `-1`：No discount\n- `1`：Amount reduction\n- `2`：Discount\n- `3`：Free shipping fee\n- `4`：Marked-up item\n- `5`：Preferential price for any N items\n- `6`：Preferential price for the combination of A and B\n- `7`：Gift\n- `8`：Fixed selling price\n- `9`：The lowest-priced item is free\n- `11`：Discount for the Nth item\n- `12`：Buy x and get y free\n- `13`：Customized\n- `14`：M (Monetary Unit) for N Items", "type": "integer" }, "code": { "name": "code", "description": "Discount code.", "type": "string", "example": "82UD6BTPX9L2" }, "description": { "name": "description", "description": "Custom discount description.", "type": "string", "example": "Custom discount description" }, "target_selection": { "name": "target_selection", "description": "Discount allocation method for line items. Valid values are: \n- `explicit`: The discount is allocated only to the explicitly specified line items. \n- `all`: The discount is allocated to all line items.\n- `entitled`: The discount is allocated only to the line items that are entitled to use the discount. ", "type": "string" }, "target_type": { "name": "target_type", "description": "Discount target type. Valid values are:\n- `line_item`: discount applied to the product\n- `shipping_line`: discount applied to the shipping fee", "type": "string" }, "title": { "name": "title", "description": "Automatic discount title.", "type": "string", "example": "Automatic discount title" }, "type": { "name": "type", "description": "Discount type. Valid values are:\n- `manual`: manual discount\n- `automatic`: automatic discount\n- `discount_code`: discount applied through a discount code", "type": "string" }, "value": { "name": "value", "description": "The specific value of the discount, in the store currency. \n- When `value_type` is `fix_amount`, this field value represents a specific discount amount. For example, if the value is `10` in CNY, it means a discount of 10 yuan. \n- When `value_type` is `percentage`, the value of this field value represents a specific discount percentage. For example, `10` means 10% off of the order amount. ", "type": "string", "example": "2.01" }, "value_type": { "name": "value_type", "description": "The type of discount value. Valid values are:\n- `fix_amount`: Fixed amount discount. For example, if `value` is `10` in CNY, it means a discount of 10 yuan. \n- `percentage`: Percentage-based discount. For example, if `value` is `10`, it means 10% off of the order amount. ", "type": "string" } }, "example": { "activity_type": null, "allocation_method": null, "benefit_type": null, "code": "82UD6BTPX9L2", "description": "Custom discount description", "target_selection": null, "target_type": null, "title": "Automatic discount title", "type": null, "value": "2.01", "value_type": null } }, "example": [ {} ] }, "discount_codes": { "name": "discount_codes", "description": "A list of promo code information. ", "type": "array", "items": { "type": "object", "properties": { "amount": { "name": "amount", "description": "Discount amount in the store currency. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "amount_set": { "name": "amount_set", "description": "The discount amount, displayed in both the buyer currency and the store currency.", "type": "object", "properties": { "presentment_money": { "name": "presentment_money", "description": "The discount amount information presented to the buyer. ", "type": "object", "properties": { "amount": { "name": "amount", "description": "The discount amount. The value is rounded to two decimal places. ", "type": "string", "example": "70.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" } }, "example": { "amount": "70.00", "currency_code": "USD" } }, "shop_money": { "name": "shop_money", "description": "The discount amount information recorded by the store.", "type": "object", "properties": { "amount": { "name": "amount", "description": "The discount amount. The value is rounded to two decimal places. ", "type": "string", "example": "10.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" } }, "example": { "amount": "10.00", "currency_code": "USD" } } }, "example": { "presentment_money": { "amount": "70.00", "currency_code": "USD" }, "shop_money": { "amount": "10.00", "currency_code": "USD" } } }, "code": { "name": "code", "description": "Promo code.", "type": "string", "example": "KIN4GNAB2FRH" }, "type": { "name": "type", "description": "Type of discount. Valid values are:\n- `减金额`: amount reduction\n- `打折`: offer a discount\n- `免运费`: free shipping\n- `加价品`: add-on purchase deal\n- `任意N件优惠价`: discount for purchasing any N items\n- `A+B组合优惠价`: discount for purchasing the product A and B combo\n- `赠品`: free gift\n- `固定售价`: fixed price\n- `最低价商品免费`: lowest-priced product free\n- `打包价`: package price\n- `第N件打折`: discount on the Nth item\n- `买x送y`: buy x and get y free\n- `自定义`: custom discount\n\n:::danger \t\n**DEPRECATED**：This parameter is deprecated from API version v20241201. \n:::", "type": "string" } }, "example": { "amount": "8.00", "amount_set": { "presentment_money": { "amount": "70.00", "currency_code": "USD" }, "shop_money": { "amount": "10.00", "currency_code": "USD" } }, "code": "KIN4GNAB2FRH", "type": null } }, "example": [ {} ] }, "email": { "name": "email", "description": "Buyer's email.", "type": "string", "example": "hok@shoplineapp.com" }, "financial_status": { "name": "financial_status", "description": "Order payment status. Valid values are:\n- `unpaid`: order not paid\n- `authorized`: order payment has been authorized\n- `pending`: order payment in progress\n- `partially_paid`: order partially paid\n- `paid`: order paid\n- `partially_refunded`: order partially refund\n- `refunded`: order refund", "type": "string" }, "fulfillment_status": { "name": "fulfillment_status", "description": "Shipping status. Valid values are:\n- `fulfilled`: order shipped\n- `partial`: order partially shipped\n- `null`: order not shipped\n", "type": "string" }, "fulfillments": { "name": "fulfillments", "description": "A list of fulfillment information. ", "type": "array", "items": { "type": "object", "properties": { "created_at": { "name": "created_at", "description": "The date and time when the fulfillment was created. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).", "type": "string", "example": "2024-08-31T02:20:26+08:00" }, "id": { "name": "id", "description": "Fulfillment ID.", "type": "string", "example": "22046737798141702810214336" }, "line_items": { "name": "line_items", "description": "Product list.", "type": "array", "items": { "type": "object", "properties": { "attribute": { "name": "attribute", "description": "The option information of the product variant, composed of the variant name and the option value. ", "type": "string", "example": "color - red" }, "bundle_parent_variant_id": { "name": "bundle_parent_variant_id", "description": "Parent product variant ID associated with the bundle child product.", "type": "string" }, "fulfillable_quantity": { "name": "fulfillable_quantity", "description": "Remaining fulfillable quantity of products at the product line level.", "type": "integer", "example": 1 }, "fulfillment_quantity": { "name": "fulfillment_quantity", "description": "The quantity of products that are actually shipped.", "type": "integer", "example": 1 }, "fulfillment_service": { "name": "fulfillment_service", "description": "Logistics company name.", "type": "string", "example": "SF Express" }, "fulfillment_status": { "name": "fulfillment_status", "description": "Shipping status. Valid values are:\n- `fulfilled`: order shipped\n- `partial`: order partially shipped\n- `null`: order not shipped", "type": "string" }, "grams": { "name": "grams", "description": "The weight of the product in grams(g). ", "type": "double", "example": 100 }, "id": { "name": "id", "description": "The ID of the product snapshots table, generated by the system. Combined with the `order.id`, it uniquely identifies a product. ", "type": "string", "example": "100" }, "image_url": { "name": "image_url", "description": "The URL address that stores the product image.", "type": "string", "example": "https://d2n979dmt31clo.cloudfront.net/image/store/4211449909/1667384795847/63928f08a7174ab2958c6a969" }, "is_bundle": { "name": "is_bundle", "description": "Whether the product is a bundle.\n\n - `true`: The product is a bundle.\n - `false`: The product is not a bundle.", "type": "boolean" }, "is_bundle_component": { "name": "is_bundle_component", "description": "Whether the product is a sub-item in a bundle.\n\n - `true`: The product is a sub-item in a bundle.\n - `false`: The product is not a sub-item in a bundle.", "type": "boolean" }, "location_id": { "name": "location_id", "description": "The unique ID of the pickup location. ", "type": "string", "example": "5445886274929439997" }, "name": { "name": "name", "description": "SKU title, same as `title`.", "type": "string", "example": "Product name" }, "price": { "name": "price", "description": "The product price in store currency. The value is rounded to two decimal places. ", "type": "string", "example": "10.00" }, "price_set": { "name": "price_set", "description": "The product price, displayed in both the store currency and the buyer currency.", "type": "object", "properties": { "presentment_money": { "name": "presentment_money", "description": "The product price information presented to the buyer. ", "type": "object", "properties": { "amount": { "name": "amount", "description": "The product price. The value is rounded to two decimal places. ", "type": "string", "example": "70.0" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" } }, "example": { "amount": "70.0", "currency_code": "USD" } }, "shop_money": { "name": "shop_money", "description": "The product price information recorded by the store.", "type": "object", "properties": { "amount": { "name": "amount", "description": "The product price. The value is rounded to two decimal places. ", "type": "string", "example": "10.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" } }, "example": { "amount": "10.00", "currency_code": "USD" } } }, "example": { "presentment_money": { "amount": "70.0", "currency_code": "USD" }, "shop_money": { "amount": "10.00", "currency_code": "USD" } } }, "product_id": { "name": "product_id", "description": "SPU serial number.", "type": "string", "example": "16056761559984840457934011" }, "quantity": { "name": "quantity", "description": "Quantity of items in the order.", "type": "integer", "example": 1 }, "requires_shipping": { "name": "requires_shipping", "description": "Indicates whether the product is subject to shipping.\n- `true`：Shipping is required.\n- `false`：Shipping is not required.", "type": "boolean" }, "sku": { "name": "sku", "description": "Product SKU serial number.", "type": "string", "example": "test-002" }, "tax_lines": { "name": "tax_lines", "description": "A list of tax information. ", "type": "array", "items": { "type": "object", "properties": { "price": { "name": "price", "description": "Tax in store currency. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "price_set": { "name": "price_set", "description": "The tax amount, displayed in both the buyer currency and the store currency.", "type": "object", "properties": { "presentment_money": { "name": "presentment_money", "description": "The tax amount information presented to the buyer. ", "type": "object", "properties": { "amount": { "name": "amount", "description": "The tax amount. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" } }, "example": { "amount": "8.00", "currency_code": "USD" } }, "shop_money": { "name": "shop_money", "description": "The tax amount information recorded by the store.", "type": "object", "properties": { "amount": { "name": "amount", "description": "The tax amount. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" } }, "example": { "amount": "8.00", "currency_code": "USD" } } }, "example": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } } }, "rate": { "name": "rate", "description": "The tax rate as a decimal value, rounded to four decimal places. For example, a 2% tax rate is represented as `0.0200`. This field value is for display only.", "type": "double" }, "title": { "name": "title", "description": "The title for the tax description, for display only. ", "type": "string", "example": "taxes" } }, "example": { "price": "8.00", "price_set": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } }, "rate": null, "title": "taxes" } }, "example": [ {} ] }, "taxable": { "name": "taxable", "description": "Whether the product is subject to tax.\n- `true`: Tax is required. \n- `false`: No tax is required.", "type": "boolean" }, "title": { "name": "title", "description": "Product title.", "type": "string", "example": "Useful product" }, "variant_id": { "name": "variant_id", "description": "A unique code assigned to a distinct product in inventory.", "type": "string", "example": "18056761559987524812644011" }, "variant_title": { "name": "variant_title", "description": "Product variant value. Multiple values are separated by `/`.", "type": "string", "example": "big/red" }, "vendor": { "name": "vendor", "description": "Supplier.", "type": "string", "example": "Supplier" } }, "example": { "attribute": "color - red", "bundle_parent_variant_id": null, "fulfillable_quantity": 1, "fulfillment_quantity": 1, "fulfillment_service": "SF Express", "fulfillment_status": null, "grams": 100, "id": "100", "image_url": "https://d2n979dmt31clo.cloudfront.net/image/store/4211449909/1667384795847/63928f08a7174ab2958c6a969", "is_bundle": null, "is_bundle_component": null, "location_id": "5445886274929439997", "name": "Product name", "price": "10.00", "price_set": { "presentment_money": { "amount": "70.0", "currency_code": "USD" }, "shop_money": { "amount": "10.00", "currency_code": "USD" } }, "product_id": "16056761559984840457934011", "quantity": 1, "requires_shipping": null, "sku": "test-002", "tax_lines": [ {} ], "taxable": null, "title": "Useful product", "variant_id": "18056761559987524812644011", "variant_title": "big/red", "vendor": "Supplier" } }, "example": [ {} ] }, "name": { "name": "name", "description": "Fulfillment code.", "type": "string", "example": "1032-F2" }, "order_id": { "name": "order_id", "description": "Order number.", "type": "string", "example": "21056577640603870897253153" }, "shipment_status": { "name": "shipment_status", "description": "Product delivery status. Valid values are:\n- `out_for_delivery`: out for delivery\n- `delivered`: delivered\n- `faliure`: delivery failed\n- `picked_up`: picked up", "type": "string" }, "status": { "name": "status", "description": "Shipping status of the order package. Valid values are:\n- `success`: shipment dispatched\n- `cancelled`: shipment has been canceled", "type": "string" }, "tracking_company": { "name": "tracking_company", "description": "Logistics service provider.", "type": "string", "example": "SF International" }, "tracking_info_list": { "name": "tracking_info_list", "description": "If this parameter is specified, the individual parameters `tracking_url`, `tracking_number`, and `tracking_company` will be ignored.Maximum of 10 tracking infos allowed.", "type": "array", "items": { "type": "object", "properties": { "tracking_company": { "name": "tracking_company", "description": "The URL for tracking the package.", "type": "string" }, "tracking_number": { "name": "tracking_number", "description": "The logistics service provider.", "type": "string" }, "tracking_url": { "name": "tracking_url", "description": "The tracking number.", "type": "string" } }, "example": { "tracking_company": null, "tracking_number": null, "tracking_url": null } } }, "tracking_number": { "name": "tracking_number", "description": "The delivery tracking number provided by the logistics service provider.", "type": "string", "example": "yun0001" }, "tracking_url": { "name": "tracking_url", "description": "The domain name of the logistics company.", "type": "string", "example": "https://www.sf-international.com/" }, "updated_at": { "name": "updated_at", "description": "The date and time when the fulfillment was updated. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).", "type": "string", "example": "2022-11-04T10:18:46+00:00" } }, "example": { "created_at": "2024-08-31T02:20:26+08:00", "id": "22046737798141702810214336", "line_items": [ {} ], "name": "1032-F2", "order_id": "21056577640603870897253153", "shipment_status": null, "status": null, "tracking_company": "SF International", "tracking_info_list": null, "tracking_number": "yun0001", "tracking_url": "https://www.sf-international.com/", "updated_at": "2022-11-04T10:18:46+00:00" } }, "example": [ {} ] }, "hidden_order": { "name": "hidden_order", "description": "Indicates whether the order is archived.\n- `true`: The order is archived.\n- `false`: The order is not archived.", "type": "boolean" }, "id": { "name": "id", "description": "Order ID, system-defined number.", "type": "string", "example": "21050224312121887324667162" }, "landing_site": { "name": "landing_site", "description": "Link to record complete order attribution landing page information.", "type": "string", "example": "https://www.url.com" }, "line_items": { "name": "line_items", "description": "A list of order product snapshot.", "type": "array", "items": { "type": "object", "properties": { "attribute": { "name": "attribute", "description": "The option information of the product variant, composed of the variant name and the option value. ", "type": "string", "example": "color - red" }, "bundle_parent_variant_id": { "name": "bundle_parent_variant_id", "description": "Parent product variant ID associated with the bundle child product.", "type": "string" }, "country_code_of_origin": { "name": "country_code_of_origin", "description": "Country or region code indicating the place of origin or shipping origin. Format: [ISO 3166-1](https://www.iso.org/iso-3166-country-codes.html).", "type": "string", "example": "US" }, "customized_attributes": { "name": "customized_attributes", "description": "A list of product custom attributes.", "type": "array", "items": { "type": "object", "properties": { "key": { "name": "key", "description": "Product custom attribute name, imported from external sources.\n\nWhen `key` is `businessType`, `value` is fixed to `3`, indicating a gift. ", "type": "string" }, "value": { "name": "value", "description": "Product custom attribute value. \n\nWhen `key` is `businessType`, `value` is fixed to `3`, indicating a gift. ", "type": "string" } }, "example": { "key": null, "value": null } } }, "discount_allocations": { "name": "discount_allocations", "description": "The discount amount, displayed in both the buyer currency and the store currency.", "type": "array", "items": { "type": "object", "properties": { "amount": { "name": "amount", "description": "The discount amount. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "amount_set": { "name": "amount_set", "description": "Discount details in multiple currencies.", "type": "object", "properties": { "presentment_money": { "name": "presentment_money", "description": "The discount amount information presented to the buyer. ", "type": "object", "properties": { "amount": { "name": "amount", "description": "The discount amount. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" } }, "example": { "amount": "8.00", "currency_code": "USD" } }, "shop_money": { "name": "shop_money", "description": "The discount amount information recorded by the store.", "type": "object", "properties": { "amount": { "name": "amount", "description": "The discount amount. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" } }, "example": { "amount": "8.00", "currency_code": "USD" } } }, "example": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } } }, "discount_application_index": { "name": "discount_application_index", "description": "The position of the discount applied to the product within the `orders.discount_applications` list.", "type": "integer", "example": 1 } }, "example": { "amount": "8.00", "amount_set": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } }, "discount_application_index": 1 } }, "example": [ {} ] }, "duties": { "name": "duties", "description": "A list of duty information.", "type": "array", "items": { "type": "object", "properties": { "country_code_of_origin": { "name": "country_code_of_origin", "description": "Country or region code indicating the place of origin or shipping origin. Format: [ISO 3166-1](https://www.iso.org/iso-3166-country-codes.html).", "type": "string", "example": "US" }, "harmonized_system_code": { "name": "harmonized_system_code", "description": "Harmonized system code, used to categorize a product in international trade. ", "type": "string", "example": "A0023" }, "id": { "name": "id", "description": "Tariff number.", "type": "string", "example": "H2325" }, "price": { "name": "price", "description": "The duty amount, displayed in both the buyer currency and the store currency.", "type": "object", "properties": { "presentment_money": { "name": "presentment_money", "description": "The duty amount information presented to the buyer. ", "type": "object", "properties": { "amount": { "name": "amount", "description": "The duty amount. The value is rounded to two decimal places. ", "type": "string", "example": "8.88" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" } }, "example": { "amount": "8.88", "currency_code": "USD" } }, "shop_money": { "name": "shop_money", "description": "The duty amount information recorded by the store.", "type": "object", "properties": { "amount": { "name": "amount", "description": "The duty amount. The value is rounded to two decimal places. ", "type": "string", "example": "8.88" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" } }, "example": { "amount": "8.88", "currency_code": "USD" } } }, "example": { "presentment_money": { "amount": "8.88", "currency_code": "USD" }, "shop_money": { "amount": "8.88", "currency_code": "USD" } } }, "tax_lines": { "name": "tax_lines", "description": "A list of tax information. ", "type": "array", "items": { "type": "object", "properties": { "price_set": { "name": "price_set", "description": "The tax amount, displayed in both the buyer currency and the store currency.", "type": "object", "properties": { "presentment_money": { "name": "presentment_money", "description": "The tax amount information presented to the buyer. ", "type": "object", "properties": { "amount": { "name": "amount", "description": "The tax amount. The value is rounded to two decimal places. ", "type": "string", "example": "8.88" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" } }, "example": { "amount": "8.88", "currency_code": "USD" } }, "shop_money": { "name": "shop_money", "description": "The tax amount information recorded by the store.", "type": "object", "properties": { "amount": { "name": "amount", "description": "The tax amount. The value is rounded to two decimal places. ", "type": "string", "example": "8.88" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" } }, "example": { "amount": "8.88", "currency_code": "USD" } } }, "example": { "presentment_money": { "amount": "8.88", "currency_code": "USD" }, "shop_money": { "amount": "8.88", "currency_code": "USD" } } }, "rate": { "name": "rate", "description": "The tax rate as a decimal value, rounded to four decimal places. For example, a 2% tax rate is represented as `0.0200`. This field value is for display only.", "type": "double" }, "rate_percentage": { "name": "rate_percentage", "description": "The tax rate as a percentage numerical value, rounded to two decimal places. For example, a 2% tax rate is represented as `2.00`. This field value is for display only.", "type": "double" }, "title": { "name": "title", "description": "The title for the tax description, for display only. ", "type": "string", "example": "Tax title" } }, "example": { "price_set": { "presentment_money": { "amount": "8.88", "currency_code": "USD" }, "shop_money": { "amount": "8.88", "currency_code": "USD" } }, "rate": null, "rate_percentage": null, "title": "Tax title" } }, "example": [ {} ] } }, "example": { "country_code_of_origin": "US", "harmonized_system_code": "A0023", "id": "H2325", "price": { "presentment_money": { "amount": "8.88", "currency_code": "USD" }, "shop_money": { "amount": "8.88", "currency_code": "USD" } }, "tax_lines": [ {} ] } }, "example": [ {} ] }, "fulfillable_quantity": { "name": "fulfillable_quantity", "description": "Remaining fulfillable quantity at product line level.", "type": "integer", "example": 1 }, "fulfillment_service": { "name": "fulfillment_service", "description": "Logistics company name.", "type": "string", "example": "SF International" }, "fulfillment_status": { "name": "fulfillment_status", "description": "Shipping status. Valid values are:\n- `fulfilled`: order shipped\n- `partial`: order partially shipped\n- `null`: order not shipped", "type": "string" }, "gift_card": { "name": "gift_card", "description": "Whether the product is a gift card.\n- `true`: gift card\n- `false`: not a gift card", "type": "boolean" }, "grams": { "name": "grams", "description": "The weight of the product in grams(g).", "type": "double", "example": 100 }, "harmonized_system_code": { "name": "harmonized_system_code", "description": "Harmonized system code, used to categorize a product in international trade. ", "type": "string", "example": "harmonized system code" }, "id": { "name": "id", "description": "The ID of the product snapshots table, generated by the system. Combined with the `order.id`, it uniquely identifies a product. ", "type": "string", "example": "417" }, "image_url": { "name": "image_url", "description": "The URL address that stores the product image.", "type": "string", "example": "https://d2n979dmt31clo.cloudfront.net/image/store/4211449909/1667384795847/63928f08a7174ab2958c6a969" }, "is_bundle": { "name": "is_bundle", "description": "Whether the product is a bundle.\n\n - `true`: The product is a bundle.\n - `false`: The product is not a bundle.", "type": "boolean" }, "is_bundle_component": { "name": "is_bundle_component", "description": "Whether the product is a sub-item in a bundle.\n\n - `true`: The product is a sub-item in a bundle.\n - `false`: The product is not a sub-item in a bundle.", "type": "boolean" }, "location_id": { "name": "location_id", "description": "Local delivery location number or standard delivery location number.", "type": "string", "example": "5327026538935748524" }, "name": { "name": "name", "description": "SKU title, same as `title`.", "type": "string", "example": "Product title" }, "price": { "name": "price", "description": "The product price in store currency. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "price_set": { "name": "price_set", "description": "The product price, displayed in both the store currency and the buyer currency.", "type": "object", "properties": { "presentment_money": { "name": "presentment_money", "description": "The product price information presented to the buyer. ", "type": "object", "properties": { "amount": { "name": "amount", "description": "The product price. The value is rounded to two decimal places. ", "type": "string", "example": "80.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" } }, "example": { "amount": "80.00", "currency_code": "USD" } }, "shop_money": { "name": "shop_money", "description": "The product price information recorded by the store.", "type": "object", "properties": { "amount": { "name": "amount", "description": "The product price. The value is rounded to two decimal places. ", "type": "string", "example": "10" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" } }, "example": { "amount": "10", "currency_code": "USD" } } }, "example": { "presentment_money": { "amount": "80.00", "currency_code": "USD" }, "shop_money": { "amount": "10", "currency_code": "USD" } } }, "product_id": { "name": "product_id", "description": "SPU serial number.", "type": "string", "example": "16056761559984840457934011" }, "properties": { "name": "properties", "description": "A list of product customization information. ", "type": "array", "items": { "type": "object", "properties": { "additional": { "name": "additional", "description": "Additional custom fields for products. For example, if `name` is `text`, `additional` can include attributes such as font size, font style, and color. ", "type": "string", "example": "Additional fields" }, "name": { "name": "name", "description": "Custom attribute name.", "type": "string", "example": "Attribute name" }, "role_visibility": { "name": "role_visibility", "description": "Custom information visibility roles: \n\n- `customer`: Visible to buyers only \n- `merchant`: Visible to merchants only\n- ` all:` Visible to both buyers and merchants \n- `none`: Hidden from both buyers and merchants", "type": "string" }, "show": { "name": "show", "description": "Whether the property is visible.\n\n - `true`: The property is visible.\n - `false`: The property is not visible.", "type": "boolean" }, "type": { "name": "type", "description": "Custom information type. Valid values are:\n- `text`: text type\n- `picture`: picture type\n- `link`: hyperlink type", "type": "string" }, "urls": { "name": "urls", "description": "URL resource list.\n- If `type` is `picture`, thumbnails are rendered via the `urls` values.\n- If `type` is `link`, the hyperlink is the first URL in the `urls` values.", "type": "array", "items": { "type": "string" }, "example": [ "https://www.url.com" ] }, "value": { "name": "value", "description": "Custom attribute value.", "type": "string", "example": "attribute value" } }, "example": { "additional": "Additional fields", "name": "Attribute name", "role_visibility": null, "show": null, "type": null, "urls": [ "https://www.url.com" ], "value": "attribute value" } }, "example": [ {} ] }, "quantity": { "name": "quantity", "description": "Quantity of items in the order.", "type": "integer", "example": 1 }, "requires_shipping": { "name": "requires_shipping", "description": "Indicates whether the product is subject to shipping.\n- `true`：Shipping is required.\n- `false`：Shipping is not required.", "type": "boolean" }, "sku": { "name": "sku", "description": "Product SKU serial number.", "type": "string", "example": "18056761559987524812644011" }, "tags": { "name": "tags", "description": "Product tags. Multiple tags are separated by commas. ", "type": "string", "example": "watch" }, "tax_lines": { "name": "tax_lines", "description": "A list of tax information. ", "type": "array", "items": { "type": "object", "properties": { "price": { "name": "price", "description": "Tax in store currency. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "price_set": { "name": "price_set", "description": "The tax amount, displayed in both the buyer currency and the store currency.", "type": "object", "properties": { "presentment_money": { "name": "presentment_money", "description": "The tax amount information presented to the buyer. ", "type": "object", "properties": { "amount": { "name": "amount", "description": "The tax amount. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" } }, "example": { "amount": "8.00", "currency_code": "USD" } }, "shop_money": { "name": "shop_money", "description": "The tax amount information recorded by the store.", "type": "object", "properties": { "amount": { "name": "amount", "description": "The tax amount. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" } }, "example": { "amount": "8.00", "currency_code": "USD" } } }, "example": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } } }, "rate": { "name": "rate", "description": "The tax rate as a decimal value, rounded to four decimal places. For example, a 2% tax rate is represented as `0.0200`. This field value is for display only.", "type": "double" }, "title": { "name": "title", "description": "The title for the tax description, for display only. ", "type": "string", "example": "taxes" }, "type": { "name": "type", "description": "Tax fee type, used to distinguish between commodity tax and freight tax.\n- `product_tax`: commodity tax \n- `shipping_tax`: freight tax", "type": "string" } }, "example": { "price": "8.00", "price_set": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } }, "rate": null, "title": "taxes", "type": null } }, "example": [ {} ] }, "taxable": { "name": "taxable", "description": "Whether the product is subject to tax.\n- `true`: Tax is required. \n- `false`: No tax is required.", "type": "boolean" }, "title": { "name": "title", "description": "Product title.", "type": "string", "example": "beautiful skirt" }, "variant_id": { "name": "variant_id", "description": "A unique code assigned to a distinct product in inventory.", "type": "string", "example": "18056761559987524812644011" }, "variant_title": { "name": "variant_title", "description": "Product variant value. Multiple values are separated by `/`.", "type": "string", "example": "big" }, "vendor": { "name": "vendor", "description": "Supplier.", "type": "string", "example": "Supplier" } }, "example": { "attribute": "color - red", "bundle_parent_variant_id": null, "country_code_of_origin": "US", "customized_attributes": null, "discount_allocations": [ {} ], "duties": [ {} ], "fulfillable_quantity": 1, "fulfillment_service": "SF International", "fulfillment_status": null, "gift_card": null, "grams": 100, "harmonized_system_code": "harmonized system code", "id": "417", "image_url": "https://d2n979dmt31clo.cloudfront.net/image/store/4211449909/1667384795847/63928f08a7174ab2958c6a969", "is_bundle": null, "is_bundle_component": null, "location_id": "5327026538935748524", "name": "Product title", "price": "8.00", "price_set": { "presentment_money": { "amount": "80.00", "currency_code": "USD" }, "shop_money": { "amount": "10", "currency_code": "USD" } }, "product_id": "16056761559984840457934011", "properties": [ {} ], "quantity": 1, "requires_shipping": null, "sku": "18056761559987524812644011", "tags": "watch", "tax_lines": [ {} ], "taxable": null, "title": "beautiful skirt", "variant_id": "18056761559987524812644011", "variant_title": "big", "vendor": "Supplier" } }, "example": [ {} ] }, "locations": { "name": "locations", "description": "A list of product pickup location addresses. ", "type": "array", "items": { "type": "object", "properties": { "address": { "name": "address", "description": "The first line of the address. This typically includes information such as the street address or a post office box number.", "type": "string", "example": "Address 1" }, "address_add": { "name": "address_add", "description": "The second line of the address. This typically includes information such as apartment, suite, or unit number. ", "type": "string", "example": "Address 22" }, "city": { "name": "city", "description": "The city in the address. ", "type": "string", "example": "Guangzhou" }, "country": { "name": "country", "description": "The country or region in the address.", "type": "string", "example": "China" }, "country_code": { "name": "country_code", "description": "A two-letter country or region code that follows the [ISO 3166-1](https://www.iso.org/iso-3166-country-codes.html) standard, used to identify a specific country or region in the address. ", "type": "string", "example": "CN" }, "district": { "name": "district", "description": "The district or county in the address.", "type": "string", "example": "Panyu District" }, "location_id": { "name": "location_id", "description": "Unique code of the pickup location.", "type": "string", "example": "5327026538935748524" }, "name": { "name": "name", "description": "Pickup location name.", "type": "string", "example": "Wanda square" }, "phone": { "name": "phone", "description": "Phone number.", "type": "string", "example": "13100000000" }, "province": { "name": "province", "description": "The province in the address.", "type": "string", "example": "Guangdong Province" }, "town": { "name": "town", "description": "The village or town in the address.", "type": "string", "example": "town" }, "type": { "name": "type", "description": "Location types. Valid values are:\n- `posLocation`: The store location where the order was placed using the POS channel. It is recommended to use `posLocationId`, because `posLocation` will be deprecated soon.\n- `pickupLocation`: The store location for customer pickup when the order's delivery method is self-pickup.\n- `productLocation`: The inventory location of the products in the order. It is recommended to use the `location` information in the product line, because `productLocation` will be deprecated soon.", "type": "string" }, "zip": { "name": "zip", "description": "The postal code information of the address. ", "type": "string", "example": "521000" } }, "example": { "address": "Address 1", "address_add": "Address 22", "city": "Guangzhou", "country": "China", "country_code": "CN", "district": "Panyu District", "location_id": "5327026538935748524", "name": "Wanda square", "phone": "13100000000", "province": "Guangdong Province", "town": "town", "type": null, "zip": "521000" } }, "example": [ {} ] }, "name": { "name": "name", "description": "Store custom order number, starting from 1001. You can set a prefix for this value, such as `test1001`.", "type": "string", "example": "test1001" }, "note": { "name": "note", "description": "Merchant notes.", "type": "string", "example": "Notes" }, "note_attributes": { "name": "note_attributes", "description": "A list of merchant note logs.", "type": "array", "items": { "type": "object", "properties": { "create_time": { "name": "create_time", "description": "Note creation date and time. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).", "type": "string", "example": "2022-11-04T10:18:46+00:00" }, "name": { "name": "name", "description": "Merchant ID, indicating the note source.", "type": "string", "example": "Note source" }, "value": { "name": "value", "description": "Note content.", "type": "string", "example": "Notes" } }, "example": { "create_time": "2022-11-04T10:18:46+00:00", "name": "Note source", "value": "Notes" } }, "example": [ {} ] }, "order_at": { "name": "order_at", "description": "Order completion date and time. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).", "type": "string", "example": "2021-08-16T08:27:57+00:00" }, "order_source": { "name": "order_source", "description": "The order source channel handle. The handle is a semantic identifier.", "type": "string" }, "order_status_url": { "name": "order_status_url", "description": "Order status page URL.", "type": "string" }, "payment_details": { "name": "payment_details", "description": "A list of order payment information. ", "type": "array", "items": { "type": "object", "properties": { "create_time": { "name": "create_time", "description": "The date and time when the payment order was created. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).", "type": "string", "example": "2021-08-16T08:27:57+00:00" }, "gateway": { "name": "gateway", "description": "Payment method name.", "type": "string", "example": "Mypay" }, "giftcard_presentment_money": { "name": "giftcard_presentment_money", "description": "The gift card amount information presented to the buyer.", "type": "object", "properties": { "amount": { "name": "amount", "description": "The giftcard amount. The value is rounded to two decimal places.", "type": "string" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard.", "type": "string" } }, "example": { "amount": null, "currency_code": null } }, "pay_amount": { "name": "pay_amount", "description": "Payment amount in the store currency. The value is rounded to two decimal places.", "type": "double", "example": 8 }, "pay_channel": { "name": "pay_channel", "description": "Payment channel.", "type": "string", "example": "Paypal" }, "pay_channel_deal_id": { "name": "pay_channel_deal_id", "description": "Payment serial number from the external channel.", "type": "string", "example": "pi_3MI897Hezv8FxjBO1uGxMPhX" }, "pay_merchant_email": { "name": "pay_merchant_email", "description": "The email address of the payment service provider.", "type": "string", "example": "Washingtontest@gmail.com" }, "pay_merchant_id": { "name": "pay_merchant_id", "description": "Payment service provider ID.", "type": "string", "example": "4201057379" }, "pay_merchant_order_id": { "name": "pay_merchant_order_id", "description": "Payment service provider order number.", "type": "string", "example": "233445354566" }, "pay_seq": { "name": "pay_seq", "description": "Payment order number.", "type": "string", "example": "23057287797738260472676128" }, "pay_status": { "name": "pay_status", "description": "Payment status. Valid values are:\n- `unpaid`: unpaid\n- `pending`: payment in process\n- `risking`: under risk control\n- `paid`：paid\n- `paid_overtime`: payment timeout\n- `paid_failed`: payment failed", "type": "string" }, "payment_method": { "name": "payment_method", "description": "Payment method.", "type": "string" }, "processed_at": { "name": "processed_at", "description": "Custom date and time for the payment order. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).", "type": "string", "example": "2023-04-12T22:59:52+08:00" }, "settle_currency": { "name": "settle_currency", "description": "The currency used by the customer to place the order. The value of this parameter is a three-letter currency code that follow the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" }, "settle_pay_amount": { "name": "settle_pay_amount", "description": "Payment amount in `settle_currency`. The value is rounded to two decimal places. ", "type": "double", "example": 8 }, "status_code": { "name": "status_code", "description": "Payment gateway standard status code.", "type": "string", "example": "RISK_PENDING" }, "status_msg": { "name": "status_msg", "description": "The description of `status_code`.", "type": "string", "example": "PENDING_REVIEW" } }, "example": { "create_time": "2021-08-16T08:27:57+00:00", "gateway": "Mypay", "giftcard_presentment_money": { "amount": null, "currency_code": null }, "pay_amount": 8, "pay_channel": "Paypal", "pay_channel_deal_id": "pi_3MI897Hezv8FxjBO1uGxMPhX", "pay_merchant_email": "Washingtontest@gmail.com", "pay_merchant_id": "4201057379", "pay_merchant_order_id": "233445354566", "pay_seq": "23057287797738260472676128", "pay_status": null, "payment_method": null, "processed_at": "2023-04-12T22:59:52+08:00", "settle_currency": "USD", "settle_pay_amount": 8, "status_code": "RISK_PENDING", "status_msg": "PENDING_REVIEW" } }, "example": [ {} ] }, "payment_gateway_names": { "name": "payment_gateway_names", "description": "Payment method list. Valid values are:\n- `SLpayments`\n- `Paypal`\n- `Oceanpay`\n- `TwoCheckout`\n- `AsiaBill`\n- `Stripe`\n- `Pacypay`\n- `WorldPay`\n- `COD`\n- `CUSTOM`\n- `adjustPay`\n- `Xendit`\n- `XenditOther`", "type": "array", "items": { "type": "string" }, "example": [ "SLpayments" ] }, "payment_terms": { "name": "payment_terms", "description": "Information related to payment terms. ", "type": "object", "properties": { "created_at": { "name": "created_at", "description": "The date and time when payment terms were created. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).", "type": "string", "example": "2024-06-05 08:00:00" }, "due_in_days": { "name": "due_in_days", "description": "Remaining days until the payment is due. This field is returned when the value of `payment_terms_type` is `NET`. ", "type": "integer", "example": 2 }, "id": { "name": "id", "description": "The unique identifier (ID) that identifies this payment term.", "type": "string", "example": "6497210673894431747" }, "overdue": { "name": "overdue", "description": "Whether the payment is overdue.\n- `true`: overdue\n- `false`: not overdue", "type": "boolean" }, "payment_schedules": { "name": "payment_schedules", "description": "A set of schedules associated with the payment terms.", "type": "array", "items": { "type": "object", "properties": { "completed_at": { "name": "completed_at", "description": "Payment completion date and time. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).", "type": "string", "example": "2024-06-05 08:00:00" }, "due_at": { "name": "due_at", "description": "Expected payment date and time. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).", "type": "string", "example": "2024-06-05 08:00:00" }, "issued_at": { "name": "issued_at", "description": "Payment start date and time. When `payment_terms_type` is `FIXED` or `NET`, `issue_at` indicates the save time of the draft order or the order itself. If the draft order is converted to an order, the order inherits the save time of the draft. When `payment_terms_type` is `FULFILLMENT` or `RECEIPT`, it refers to the payment start date and time. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). ", "type": "string", "example": "2024-06-05 08:00:00" } }, "example": { "completed_at": "2024-06-05 08:00:00", "due_at": "2024-06-05 08:00:00", "issued_at": "2024-06-05 08:00:00" } } }, "payment_terms_name": { "name": "payment_terms_name", "description": "The name of the payment terms template used to create the payment terms.", "type": "string", "example": "Due on receipt" }, "payment_terms_type": { "name": "payment_terms_type", "description": "The type of payment terms template used to create the payment terms. Valid values are:\n- `FIXED`: Merchant specified date\n- `FULFILLMENT`: Fulfillment (Shipment) completion date\n- `NET`: Fixed condition date\n- `RECEIPT`: Billing sent date\n- `UNKNOWN`: Unknown type", "type": "string" }, "updated_at": { "name": "updated_at", "description": "The date and time when the payment term was updated. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).", "type": "string", "example": "2024-06-05 08:00:00" } }, "example": { "created_at": "2024-06-05 08:00:00", "due_in_days": 2, "id": "6497210673894431747", "overdue": null, "payment_schedules": null, "payment_terms_name": "Due on receipt", "payment_terms_type": null, "updated_at": "2024-06-05 08:00:00" } }, "phone": { "name": "phone", "description": "Buyer's mobile phone number.", "type": "string", "example": "18978789878" }, "po_number": { "name": "po_number", "description": "Purchase order number for a B2B order.", "type": "string" }, "pos_location_id": { "name": "pos_location_id", "description": "POS trading location ID.", "type": "string", "example": "5327026538935748524" }, "presentment_currency": { "name": "presentment_currency", "description": "Buyer currency, the same as the store currency. A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard.", "type": "string", "example": "USD" }, "processed_at": { "name": "processed_at", "description": "Order completion date and time. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).", "type": "string", "example": "2023-04-12T22:59:52+08:00" }, "processed_user_id": { "name": "processed_user_id", "description": "The ID of the order creator.", "type": "string", "example": "4201057495" }, "referring_site": { "name": "referring_site", "description": "Attribution URL, used to record how the buyer was redirected to the online store. ", "type": "string", "example": "https://www.referringSite.com" }, "refunds": { "name": "refunds", "description": "Refund list.", "type": "array", "items": { "type": "object", "properties": { "created_at": { "name": "created_at", "description": "The date and time when the refund order was created. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).", "type": "string", "example": "2021-08-16T08:27:57+00:00" }, "id": { "name": "id", "description": "Refund ID.", "type": "string", "example": "2605659027312156877634" }, "note": { "name": "note", "description": "Refund notes of merchant.", "type": "string", "example": "Refund notes" }, "order_adjustments": { "name": "order_adjustments", "description": "A list of adjusted order information, used to record two types of information: \n- Refund information related to shipping costs ( `kind` is `shipping_refund` ).\n- The difference between the automatically calculated refund amount and the actual refund amount ( `kind` is `refund_discrepancy` ).", "type": "array", "items": { "type": "object", "properties": { "amount": { "name": "amount", "description": "The adjustment order amount. The value is rounded to two decimal places.", "type": "string", "example": "8.00" }, "amount_set": { "name": "amount_set", "description": "The adjustment order amount, displayed in both the buyer currency and the store currency.", "type": "object", "properties": { "presentment_money": { "name": "presentment_money", "description": "The adjustment order amount information presented to the buyer. ", "type": "object", "properties": { "amount": { "name": "amount", "description": "The adjustment order amount. The value is rounded to two decimal places. ", "type": "double", "example": 8 }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard.", "type": "string", "example": "USD" } }, "example": { "amount": 8, "currency_code": "USD" } }, "shop_money": { "name": "shop_money", "description": "The adjustment order amount information recorded by the store.", "type": "object", "properties": { "amount": { "name": "amount", "description": "The adjustment order amount. The value is rounded to two decimal places. ", "type": "double", "example": 8 }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" } }, "example": { "amount": 8, "currency_code": "USD" } } }, "example": { "presentment_money": { "amount": 8, "currency_code": "USD" }, "shop_money": { "amount": 8, "currency_code": "USD" } } }, "id": { "name": "id", "description": "The adjustment order ID. ", "type": "string", "example": "RAP5570565996182771228" }, "kind": { "name": "kind", "description": "The adjustment order type. Valid values are:\n- `refund_discrepancy`: shipping amount adjustment\n- `shipping_refund`: payment order amount adjustment", "type": "string" }, "order_id": { "name": "order_id", "description": "Order number.", "type": "string", "example": "21056577640603870897253153" }, "reason": { "name": "reason", "description": "Reason for adjustment.", "type": "string", "example": "Refund discrepancy" }, "refund_id": { "name": "refund_id", "description": "The refund order ID. ", "type": "string", "example": "2605659027312156877634" }, "tax_amount": { "name": "tax_amount", "description": "The tax amount of the adjusted order in store currency. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "tax_amount_set": { "name": "tax_amount_set", "description": "The tax amount of the adjustment order, displayed in both the buyer currency and the store currency.", "type": "object", "properties": { "presentment_money": { "name": "presentment_money", "description": "The tax amount information presented to the buyer. ", "type": "object", "properties": { "amount": { "name": "amount", "description": "The tax amount. The value is rounded to two decimal places. ", "type": "double", "example": 8 }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard.", "type": "string", "example": "USD" } }, "example": { "amount": 8, "currency_code": "USD" } }, "shop_money": { "name": "shop_money", "description": "The tax amount information recorded by the store.", "type": "object", "properties": { "amount": { "name": "amount", "description": "The tax amount. The value is rounded to two decimal places. ", "type": "double", "example": 8 }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" } }, "example": { "amount": 8, "currency_code": "USD" } } }, "example": { "presentment_money": { "amount": 8, "currency_code": "USD" }, "shop_money": { "amount": 8, "currency_code": "USD" } } } }, "example": { "amount": "8.00", "amount_set": { "presentment_money": { "amount": 8, "currency_code": "USD" }, "shop_money": { "amount": 8, "currency_code": "USD" } }, "id": "RAP5570565996182771228", "kind": null, "order_id": "21056577640603870897253153", "reason": "Refund discrepancy", "refund_id": "2605659027312156877634", "tax_amount": "8.00", "tax_amount_set": { "presentment_money": { "amount": 8, "currency_code": "USD" }, "shop_money": { "amount": 8, "currency_code": "USD" } } } }, "example": [ {} ] }, "order_id": { "name": "order_id", "description": "Order number.", "type": "string", "example": "21056577640603870897253153" }, "processed_at": { "name": "processed_at", "description": "Refund initiation date and time. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).", "type": "string", "example": "2021-08-16T08:27:57+00:00" }, "refund_line_items": { "name": "refund_line_items", "description": "A list of refund details for each item line. ", "type": "array", "items": { "type": "object", "properties": { "id": { "name": "id", "description": "Refund order number.", "type": "string", "example": "2605659027312156877634" }, "line_item": { "name": "line_item", "description": "The product line information in the fulfillment order.", "type": "object", "properties": { "attribute": { "name": "attribute", "description": "The option information of the product variant, composed of the variant name and the option value. ", "type": "string", "example": "color - red" }, "fulfillable_quantity": { "name": "fulfillable_quantity", "description": "Remaining fulfillable quantity at product line level.", "type": "integer", "example": 1 }, "fulfillment_service": { "name": "fulfillment_service", "description": "Logistics company name.", "type": "string", "example": "SF International" }, "fulfillment_status": { "name": "fulfillment_status", "description": "Shipping status. Valid values are:\n- `fulfilled`: order shipped\n- `partial`: order partially shipped\n- `null`: order not shipped", "type": "string" }, "grams": { "name": "grams", "description": "The weight of the product in grams(g). ", "type": "double", "example": 1 }, "id": { "name": "id", "description": "The ID of the product snapshots table, generated by the system. Combined with the `order.id`, it uniquely identifies a product. ", "type": "string", "example": "403" }, "name": { "name": "name", "description": "SKU title, same as `title`.", "type": "string", "example": "18056761559987524812644011" }, "price": { "name": "price", "description": "The product price in store currency. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "price_set": { "name": "price_set", "description": "The product price, displayed in both the store currency and the buyer currency.", "type": "object", "properties": { "presentment_money": { "name": "presentment_money", "description": "The product price information presented to the buyer. ", "type": "object", "properties": { "amount": { "name": "amount", "description": "The product price. The value is rounded to two decimal places. ", "type": "string", "example": "10.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" } }, "example": { "amount": "10.00", "currency_code": "USD" } }, "shop_money": { "name": "shop_money", "description": "The product price information recorded by the store.", "type": "object", "properties": { "amount": { "name": "amount", "description": "The product price. The value is rounded to two decimal places. ", "type": "string", "example": "70.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard.", "type": "string", "example": "USD" } }, "example": { "amount": "70.00", "currency_code": "USD" } } }, "example": { "presentment_money": { "amount": "10.00", "currency_code": "USD" }, "shop_money": { "amount": "70.00", "currency_code": "USD" } } }, "product_id": { "name": "product_id", "description": "SPU serial number.", "type": "string", "example": "16056761559984840457934011" }, "quantity": { "name": "quantity", "description": "Quantity of items in the order.", "type": "integer", "example": 1 }, "requires_shipping": { "name": "requires_shipping", "description": "Indicates whether the product is subject to shipping.\n- `true`：Shipping is required.\n- `false`：Shipping is not required.", "type": "boolean" }, "sku": { "name": "sku", "description": "Product SKU serial number.", "type": "string", "example": "sku name" }, "tax_lines": { "name": "tax_lines", "description": "A list of tax information. ", "type": "array", "items": { "type": "object", "properties": { "price": { "name": "price", "description": "Tax in store currency. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "price_set": { "name": "price_set", "description": "The tax amount, displayed in both the buyer currency and the store currency.", "type": "object", "properties": { "presentment_money": { "name": "presentment_money", "description": "The tax amount information presented to the buyer. ", "type": "object", "properties": { "amount": { "name": "amount", "description": "The tax amount. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" } }, "example": { "amount": "8.00", "currency_code": "USD" } }, "shop_money": { "name": "shop_money", "description": "The tax amount information recorded by the store.", "type": "object", "properties": { "amount": { "name": "amount", "description": "The tax amount. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" } }, "example": { "amount": "8.00", "currency_code": "USD" } } }, "example": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } } }, "rate": { "name": "rate", "description": "The tax rate as a decimal value, rounded to four decimal places. For example, a 2% tax rate is represented as `0.0200`. This field value is for display only.", "type": "double" }, "title": { "name": "title", "description": "The title for the tax description, for display only. ", "type": "string", "example": "Headline" } }, "example": { "price": "8.00", "price_set": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } }, "rate": null, "title": "Headline" } }, "example": [ {} ] }, "taxable": { "name": "taxable", "description": "Whether the product is subject to tax.\n- `true`: Tax is required. \n- `false`: No tax is required.", "type": "boolean" }, "title": { "name": "title", "description": "Product title.", "type": "string", "example": "Product title" }, "variant_id": { "name": "variant_id", "description": "A unique code assigned to a distinct product in inventory.", "type": "string", "example": "18056761559987524812644011" }, "variant_title": { "name": "variant_title", "description": "Product variant value. Multiple values are separated by `/`.", "type": "string", "example": "big/red" }, "vendor": { "name": "vendor", "description": "Supplier.", "type": "string", "example": "Supplier" } }, "example": { "attribute": "color - red", "fulfillable_quantity": 1, "fulfillment_service": "SF International", "fulfillment_status": null, "grams": 1, "id": "403", "name": "18056761559987524812644011", "price": "8.00", "price_set": { "presentment_money": { "amount": "10.00", "currency_code": "USD" }, "shop_money": { "amount": "70.00", "currency_code": "USD" } }, "product_id": "16056761559984840457934011", "quantity": 1, "requires_shipping": null, "sku": "sku name", "tax_lines": [ {} ], "taxable": null, "title": "Product title", "variant_id": "18056761559987524812644011", "variant_title": "big/red", "vendor": "Supplier" } }, "line_item_id": { "name": "line_item_id", "description": "The ID of the product snapshots table, generated by the system. Combined with the `order.id`, it uniquely identifies a product. ", "type": "string", "example": "406" }, "quantity": { "name": "quantity", "description": "The quantity of refunded products.", "type": "integer", "example": 1 }, "restock_type": { "name": "restock_type", "description": "Inventory return type. Valid values are:\n- `no_restock`: not returned\n- `cancel`: canceled\n- `return`: returned", "type": "string" }, "subtotal": { "name": "subtotal", "description": "The total amount of the refund in the store currency. It is calculated as the product of the unit price and quantity. ", "type": "double", "example": 8 }, "subtotal_set": { "name": "subtotal_set", "description": "The total amount of the refund displayed in both the buyer currency and the store currency. It is calculated as the product of the unit price and quantity. ", "type": "object", "properties": { "presentment_money": { "name": "presentment_money", "description": "The refund amount information presented to the buyer. ", "type": "object", "properties": { "amount": { "name": "amount", "description": "The refund amount. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard.", "type": "string", "example": "USD" } }, "example": { "amount": "8.00", "currency_code": "USD" } }, "shop_money": { "name": "shop_money", "description": "The refund amount information recorded by the store.", "type": "object", "properties": { "amount": { "name": "amount", "description": "The refund amount. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" } }, "example": { "amount": "8.00", "currency_code": "USD" } } }, "example": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } } }, "total_tax": { "name": "total_tax", "description": "The tax amount of the refunded products, displayed in the store currency. The value is rounded to two decimal places.", "type": "double", "example": 8 }, "total_tax_set": { "name": "total_tax_set", "description": "The tax amount of the refunded products, displayed in both the buyer currency and the store currency.", "type": "object", "properties": { "presentment_money": { "name": "presentment_money", "description": "The tax amount information presented to the buyer. ", "type": "object", "properties": { "amount": { "name": "amount", "description": "The tax amount. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" } }, "example": { "amount": "8.00", "currency_code": "USD" } }, "shop_money": { "name": "shop_money", "description": "The tax amount information recorded by the store.", "type": "object", "properties": { "amount": { "name": "amount", "description": "The tax amount. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" } }, "example": { "amount": "8.00", "currency_code": "USD" } } }, "example": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } } } }, "example": { "id": "2605659027312156877634", "line_item": { "attribute": "color - red", "fulfillable_quantity": 1, "fulfillment_service": "SF International", "fulfillment_status": null, "grams": 1, "id": "403", "name": "18056761559987524812644011", "price": "8.00", "price_set": { "presentment_money": { "amount": "10.00", "currency_code": "USD" }, "shop_money": { "amount": "70.00", "currency_code": "USD" } }, "product_id": "16056761559984840457934011", "quantity": 1, "requires_shipping": null, "sku": "sku name", "tax_lines": [ {} ], "taxable": null, "title": "Product title", "variant_id": "18056761559987524812644011", "variant_title": "big/red", "vendor": "Supplier" }, "line_item_id": "406", "quantity": 1, "restock_type": null, "subtotal": 8, "subtotal_set": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } }, "total_tax": 8, "total_tax_set": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } } } }, "example": [ {} ] }, "transactions": { "name": "transactions", "description": "A list of refund transaction information. ", "type": "array", "items": { "type": "object", "properties": { "amount": { "name": "amount", "description": "The refund amount. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "channel_refund_id": { "name": "channel_refund_id", "description": "A unique identifier for the refund order from the external channel or payment provider.", "type": "string" }, "created_at": { "name": "created_at", "description": "The date and time when the refund transaction order was created. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).", "type": "string", "example": "2021-08-16T08:27:57+00:00" }, "currency": { "name": "currency", "description": "Three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" }, "gateway": { "name": "gateway", "description": "Payment channel code. ", "type": "string", "example": "Mypay" }, "id": { "name": "id", "description": "Refund ID.", "type": "string", "example": "2605659027312156877634" }, "kind": { "name": "kind", "description": "Transaction type. The value is fixed to `refund`.", "type": "string", "example": "refund" }, "order_id": { "name": "order_id", "description": "Order number.", "type": "string", "example": "21056577640603870897253153" }, "processed_at": { "name": "processed_at", "description": "Refund order update date and time. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).", "type": "string", "example": "2021-08-16T08:27:57+00:00" }, "settle_amount": { "name": "settle_amount", "description": "Refund amount in the settlement currency ( `settle_currency` ). The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "settle_currency": { "name": "settle_currency", "description": "Refund settlement currency. The value of this parameter is a three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" }, "status": { "name": "status", "description": "Refund status. Valid values are: \n- `pending`: refund in progress\n- `failure`: refund failed\n- `success`: refund successful\n- `error`: refund error", "type": "string" }, "status_update_at": { "name": "status_update_at", "description": "Update time of the refund order status.", "type": "string" }, "user_id": { "name": "user_id", "description": "Buyer ID.", "type": "string", "example": "4201057495" } }, "example": { "amount": "8.00", "channel_refund_id": null, "created_at": "2021-08-16T08:27:57+00:00", "currency": "USD", "gateway": "Mypay", "id": "2605659027312156877634", "kind": "refund", "order_id": "21056577640603870897253153", "processed_at": "2021-08-16T08:27:57+00:00", "settle_amount": "8.00", "settle_currency": "USD", "status": null, "status_update_at": null, "user_id": "4201057495" } }, "example": [ {} ] }, "user_id": { "name": "user_id", "description": "Buyer ID.", "type": "string", "example": "4201057495" } }, "example": { "created_at": "2021-08-16T08:27:57+00:00", "id": "2605659027312156877634", "note": "Refund notes", "order_adjustments": [ {} ], "order_id": "21056577640603870897253153", "processed_at": "2021-08-16T08:27:57+00:00", "refund_line_items": [ {} ], "transactions": [ {} ], "user_id": "4201057495" } }, "example": [ {} ] }, "service": { "name": "service", "description": "Shipping method type. Valid values are:\n- `Pickup`: pick up at the store\n- `null`: other shipping methods", "type": "string" }, "shipping_address": { "name": "shipping_address", "description": "The address used for receiving packages.", "type": "object", "properties": { "address1": { "name": "address1", "description": "The first line of the address. This typically includes information such as the street address or a post office box number.", "type": "string", "example": "Address 1" }, "address2": { "name": "address2", "description": "The second line of the address. This typically includes information such as apartment, suite, or unit number. ", "type": "string", "example": "Address 2" }, "city": { "name": "city", "description": "The city in the address. ", "type": "string", "example": "City" }, "company": { "name": "company", "description": "The company name of the recipient. ", "type": "string", "example": "Company Name" }, "country": { "name": "country", "description": "The country or region in the address.", "type": "string", "example": "China" }, "country_code": { "name": "country_code", "description": "A two-letter country or region code that follows the [ISO 3166-1](https://www.iso.org/iso-3166-country-codes.html) standard, used to identify a specific country or region in the address. ", "type": "string", "example": "US" }, "delivery_store_code": { "name": "delivery_store_code", "description": "Store code for the \"Deliver to Store\" delivery method in Taiwan.", "type": "string", "example": "1001" }, "delivery_store_name": { "name": "delivery_store_name", "description": "Store name for the \"Deliver to Store\" delivery method in Taiwan.", "type": "string", "example": "Store name" }, "district": { "name": "district", "description": "The district in the address.", "type": "string", "example": "Panyu District" }, "district_code": { "name": "district_code", "description": "The district code in the address.", "type": "string", "example": "521000" }, "first_name": { "name": "first_name", "description": "The first name of the recipient. ", "type": "string", "example": "Tom" }, "last_name": { "name": "last_name", "description": "The last name of the recipient. ", "type": "string", "example": "Washington" }, "latitude": { "name": "latitude", "description": "The latitude where the address is located.", "type": "string", "example": "15" }, "longitude": { "name": "longitude", "description": "The longitude where the address is located.", "type": "string", "example": "41" }, "name": { "name": "name", "description": "The full name of the recipient. ", "type": "string", "example": "Tom.Washington" }, "phone": { "name": "phone", "description": "The phone number of the recipient. ", "type": "string", "example": "13100000000" }, "province": { "name": "province", "description": "The province in the address.", "type": "string", "example": "Guangdong Province" }, "province_code": { "name": "province_code", "description": "The code for the province in the address, which can be a custom code or a two-digit [ISO 3166-2](https://www.iso.org/iso-3166-country-codes.html#2012_iso3166-2) international code.", "type": "string", "example": "510000" }, "standard_province_code": { "name": "standard_province_code", "description": "The code for the province in the shipping address, which is a two-digit [ISO 3166-2](https://www.iso.org/iso-3166-country-codes.html#2012_iso3166-2) international code.This differs from `province_code` - the `province_code` response field uses a custom code.", "type": "string" }, "zip": { "name": "zip", "description": "The postal code information of the address. ", "type": "string", "example": "521000" } }, "example": { "address1": "Address 1", "address2": "Address 2", "city": "City", "company": "Company Name", "country": "China", "country_code": "US", "delivery_store_code": "1001", "delivery_store_name": "Store name", "district": "Panyu District", "district_code": "521000", "first_name": "Tom", "last_name": "Washington", "latitude": "15", "longitude": "41", "name": "Tom.Washington", "phone": "13100000000", "province": "Guangdong Province", "province_code": "510000", "standard_province_code": null, "zip": "521000" } }, "shipping_lines": { "name": "shipping_lines", "description": "A list of shipping fee.", "type": "array", "items": { "type": "object", "properties": { "code": { "name": "code", "description": "Only local delivery shipping methods will return a value, displayed as `Local delivery` .", "type": "string", "example": "Local delivery" }, "discount_allocations": { "name": "discount_allocations", "description": "A list of discount details.", "type": "array", "items": { "type": "object", "properties": { "amount": { "name": "amount", "description": "The discount amount in store currency. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "amount_set": { "name": "amount_set", "description": "The discount amount, displayed in both the buyer currency and the store currency.", "type": "object", "properties": { "presentment_money": { "name": "presentment_money", "description": "The discount amount information presented to the buyer. ", "type": "object", "properties": { "amount": { "name": "amount", "description": "The discount amount. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" } }, "example": { "amount": "8.00", "currency_code": "USD" } }, "shop_money": { "name": "shop_money", "description": "The discount amount information recorded by the store.", "type": "object", "properties": { "amount": { "name": "amount", "description": "The discount amount. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard.", "type": "string", "example": "USD" } }, "example": { "amount": "8.00", "currency_code": "USD" } } }, "example": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } } }, "discount_application_index": { "name": "discount_application_index", "description": "The position of the discount applied to the product within the `orders.discount_applications` list.", "type": "integer", "example": 1 } }, "example": { "amount": "8.00", "amount_set": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } }, "discount_application_index": 1 } }, "example": [ {} ] }, "discounted_price": { "name": "discounted_price", "description": "Discount amount. The value is rounded to two decimal places, is displayed in the store currency", "type": "string", "example": "8.00" }, "discounted_price_set": { "name": "discounted_price_set", "description": "The discount amount, displayed in both the buyer currency and the store currency.", "type": "object", "properties": { "presentment_money": { "name": "presentment_money", "description": "The discount amount information presented to the buyer. ", "type": "object", "properties": { "amount": { "name": "amount", "description": "The discount amount. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" } }, "example": { "amount": "8.00", "currency_code": "USD" } }, "shop_money": { "name": "shop_money", "description": "The discount amount information recorded by the store.", "type": "object", "properties": { "amount": { "name": "amount", "description": "The discount amount. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" } }, "example": { "amount": "8.00", "currency_code": "USD" } } }, "example": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } } }, "phone": { "name": "phone", "description": "Buyer's phone.", "type": "string", "example": "13100000000" }, "price": { "name": "price", "description": "The shipping fee amount in store currency. The value is rounded to two decimal places.", "type": "string", "example": "8.00" }, "price_set": { "name": "price_set", "description": "The shipping fee amount, displayed in both the buyer currency and the store currency.", "type": "object", "properties": { "presentment_money": { "name": "presentment_money", "description": "The shipping fee information presented to the buyer. ", "type": "object", "properties": { "amount": { "name": "amount", "description": "The shipping fee. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard.", "type": "string", "example": "USD" } }, "example": { "amount": "8.00", "currency_code": "USD" } }, "shop_money": { "name": "shop_money", "description": "The shipping fee information recorded by the store.", "type": "object", "properties": { "amount": { "name": "amount", "description": "The shipping fee. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" } }, "example": { "amount": "8.00", "currency_code": "USD" } } }, "example": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } } }, "requested_fulfillment_service_id": { "name": "requested_fulfillment_service_id", "description": "Transportation service code.", "type": "string" }, "shipping_price": { "name": "shipping_price", "description": "The original shipping fee in store currency, excluding the amount after discount. The value is rounded to two decimal places.", "type": "string", "example": "8.00" }, "shipping_price_set": { "name": "shipping_price_set", "description": "The original shipping fee, excluding the amount after discount, displayed in both the buyer currency and the store currency.", "type": "object", "properties": { "presentment_money": { "name": "presentment_money", "description": "The shipping fee information presented to the buyer. ", "type": "object", "properties": { "amount": { "name": "amount", "description": "The shipping fee. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" } }, "example": { "amount": "8.00", "currency_code": "USD" } }, "shop_money": { "name": "shop_money", "description": "The shipping fee information recorded by the store.", "type": "object", "properties": { "amount": { "name": "amount", "description": "The shipping fee. The value is rounded to two decimal places. ", "type": "string", "example": "1.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard.", "type": "string", "example": "USD" } }, "example": { "amount": "1.00", "currency_code": "USD" } } }, "example": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "1.00", "currency_code": "USD" } } }, "shipping_strategy_name": { "name": "shipping_strategy_name", "description": "The name of the shipping strategy. It has a corresponding value only when the shipping method is `SHIPPING` or `LOCAL_DELIVERY`.", "type": "string" }, "source": { "name": "source", "description": "Logistics carrier type. Valid values are:\n- `Shipper`: Shipper logistics\n- `Oneship`: Oneship logistics\n- `Api`: logistics carriers added via open API capabilities\n- `null`: system logistics or custom logistics", "type": "string" }, "tax_lines": { "name": "tax_lines", "description": "A list of logistics tax information.", "type": "array", "items": { "type": "object", "properties": { "price": { "name": "price", "description": "Tax in store currency. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "price_set": { "name": "price_set", "description": "The tax amount, displayed in both the buyer currency and the store currency.", "type": "object", "properties": { "presentment_money": { "name": "presentment_money", "description": "The tax amount information presented to the buyer. ", "type": "object", "properties": { "amount": { "name": "amount", "description": "The tax amount. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" } }, "example": { "amount": "8.00", "currency_code": "USD" } }, "shop_money": { "name": "shop_money", "description": "The tax amount information recorded by the store.", "type": "object", "properties": { "amount": { "name": "amount", "description": "The tax amount. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" } }, "example": { "amount": "8.00", "currency_code": "USD" } } }, "example": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } } }, "rate": { "name": "rate", "description": "The tax rate as a decimal value, rounded to four decimal places. For example, a 2% tax rate is represented as `0.0200`. This field value is for display only.", "type": "double" }, "title": { "name": "title", "description": "The title for the tax description, for display only. ", "type": "string", "example": "Tax name" } }, "example": { "price": "8.00", "price_set": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } }, "rate": null, "title": "Tax name" } }, "example": [ {} ] }, "title": { "name": "title", "description": "Logistics company name.", "type": "string", "example": "SF International" } }, "example": { "code": "Local delivery", "discount_allocations": [ {} ], "discounted_price": "8.00", "discounted_price_set": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } }, "phone": "13100000000", "price": "8.00", "price_set": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } }, "requested_fulfillment_service_id": null, "shipping_price": "8.00", "shipping_price_set": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "1.00", "currency_code": "USD" } }, "shipping_strategy_name": null, "source": null, "tax_lines": [ {} ], "title": "SF International" } }, "example": [ {} ] }, "source_identifier": { "name": "source_identifier", "description": "The marketing referral code carried by the store link through which the customer accesses the store. The field value is extracted from the URL parameter `ref`, `resource`, or `r`. For example, if the customer visits the URL `myshopline.com/products/slide?ref=22dd9dctg`, then the value of this field is `22dd9dctg`. ", "type": "string" }, "source_name": { "name": "source_name", "description": "Indicates the category of the app that initiated this API. Valid values are:\n- `sales_plugin_of`: The distribution app in the marketing system \n- `member_plugin_referral`: The referral app in the membership system", "type": "string" }, "source_url": { "name": "source_url", "description": "Attribution URL, used to record how the buyer was redirected to the online store. ", "type": "string" }, "status": { "name": "status", "description": "Order status. Valid values are：\n- `open`: The order is processing.\n- `canceled`: The order is cancelled.", "type": "string" }, "store_id": { "name": "store_id", "description": "Store ID.", "type": "string", "example": "1644828244663" }, "subtotal_price": { "name": "subtotal_price", "description": "The final price after discounts, calculated as the total product price minus any marketing discounts and custom discounts. The amount is displayed in the store currency.", "type": "string", "example": "8.00" }, "subtotal_price_set": { "name": "subtotal_price_set", "description": "The final price after discounts, calculated as the total product price minus any marketing discounts and custom discounts. This field contains amounts displayed in both the buyer and store currencies.", "type": "object", "properties": { "presentment_money": { "name": "presentment_money", "description": "The final price information presented to the buyer. ", "type": "object", "properties": { "amount": { "name": "amount", "description": "The final price. The value is rounded to two decimal places. ", "type": "string", "example": "1.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" } }, "example": { "amount": "1.00", "currency_code": "USD" } }, "shop_money": { "name": "shop_money", "description": "The final price information recorded by the store.", "type": "object", "properties": { "amount": { "name": "amount", "description": "The final price. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" } }, "example": { "amount": "8.00", "currency_code": "USD" } } }, "example": { "presentment_money": { "amount": "1.00", "currency_code": "USD" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } } }, "tags": { "name": "tags", "description": "Order tag.", "type": "string", "example": "Label" }, "tax_description": { "name": "tax_description", "description": "The description for the tax.", "type": "string" }, "tax_lines": { "name": "tax_lines", "description": "A list of tax information. ", "type": "array", "items": { "type": "object", "properties": { "name": { "name": "name", "description": "Tax name.", "type": "string", "example": "Tax name" }, "price": { "name": "price", "description": "Tax in store currency. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "price_set": { "name": "price_set", "description": "The tax amount, displayed in both the buyer currency and the store currency.", "type": "object", "properties": { "presentment_money": { "name": "presentment_money", "description": "The tax amount information presented to the buyer. ", "type": "object", "properties": { "amount": { "name": "amount", "description": "The tax amount. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" } }, "example": { "amount": "8.00", "currency_code": "USD" } }, "shop_money": { "name": "shop_money", "description": "The tax amount information recorded by the store.", "type": "object", "properties": { "amount": { "name": "amount", "description": "The tax amount. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" } }, "example": { "amount": "8.00", "currency_code": "USD" } } }, "example": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } } }, "rate": { "name": "rate", "description": "The tax rate as a decimal value, rounded to four decimal places. For example, a 2% tax rate is represented as `0.0200`. This field value is for display only.", "type": "double" }, "title": { "name": "title", "description": "The title for the tax description, for display only. ", "type": "string", "example": "Tax name" } }, "example": { "name": "Tax name", "price": "8.00", "price_set": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } }, "rate": null, "title": "Tax name" } }, "example": [ {} ] }, "tax_number": { "name": "tax_number", "description": "Tax ID.", "type": "string" }, "tax_type": { "name": "tax_type", "description": "The type of tax applicable to the order. Valid values are:\n- `product_tax`: product tax\n- `shipping_tax`: shipping tax", "type": "string" }, "taxes_included": { "name": "taxes_included", "description": "Indicates whether this order includes taxes.\n- `true`: including taxes\n- `false`: excluding taxes", "type": "boolean" }, "total_discounts": { "name": "total_discounts", "description": "The total order discount, calculated as the sum of marketing discounts and custom discounts. The amount is rounded to two decimal places and displayed in the store currency.\n\n:::danger\n**DEPRECATED**：This parameter is deprecated from API version v20210901.\n:::", "type": "string", "example": "3.25" }, "total_discounts_set": { "name": "total_discounts_set", "description": "The total order discount, calculated as the sum of marketing discounts and custom discounts. This field contains amounts displayed in both the buyer and store currencies.\n\n:::danger\n**DEPRECATED**：This parameter is deprecated from API version v20210901.\n:::", "type": "object", "properties": { "presentment_money": { "name": "presentment_money", "description": "The discount amount information presented to the buyer. ", "type": "object", "properties": { "amount": { "name": "amount", "description": "The discount amount. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" } }, "example": { "amount": "8.00", "currency_code": "USD" } }, "shop_money": { "name": "shop_money", "description": "The discount amount information recorded by the store.", "type": "object", "properties": { "amount": { "name": "amount", "description": "The discount amount. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" } }, "example": { "amount": "8.00", "currency_code": "USD" } } }, "example": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } } }, "total_line_items_price": { "name": "total_line_items_price", "description": "The total original price of the products, rounded to two decimal places, displayed in the store currency.", "type": "string", "example": "8.00" }, "total_line_items_price_set": { "name": "total_line_items_price_set", "description": "The total original price of the products, displayed in both the buyer currency and the store currency.", "type": "object", "properties": { "presentment_money": { "name": "presentment_money", "description": "The original price information presented to the buyer. ", "type": "object", "properties": { "amount": { "name": "amount", "description": "The original price. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" } }, "example": { "amount": "8.00", "currency_code": "USD" } }, "shop_money": { "name": "shop_money", "description": "The original price information recorded by the store.", "type": "object", "properties": { "amount": { "name": "amount", "description": "The original price. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" } }, "example": { "amount": "8.00", "currency_code": "USD" } } }, "example": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } } }, "total_outstanding": { "name": "total_outstanding", "description": "The total unpaid amount in the store currency. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "total_shipping_price_set": { "name": "total_shipping_price_set", "description": "The total shipping fee for the order, displayed in both the buyer currency and the store currency.", "type": "object", "properties": { "presentment_money": { "name": "presentment_money", "description": "The shipping fee information presented to the buyer. ", "type": "object", "properties": { "amount": { "name": "amount", "description": "The shipping fee. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" } }, "example": { "amount": "8.00", "currency_code": "USD" } }, "shop_money": { "name": "shop_money", "description": "The shipping fee information recorded by the store.", "type": "object", "properties": { "amount": { "name": "amount", "description": "The shipping fee. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" } }, "example": { "amount": "8.00", "currency_code": "USD" } } }, "example": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } } }, "total_tax": { "name": "total_tax", "description": "The total tax amount in the store currency. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "total_tax_set": { "name": "total_tax_set", "description": "The total tax amount, displayed in both the buyer currency and the store currency.", "type": "object", "properties": { "presentment_money": { "name": "presentment_money", "description": "The tax amount information presented to the buyer. ", "type": "object", "properties": { "amount": { "name": "amount", "description": "The tax amount. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" } }, "example": { "amount": "8.00", "currency_code": "USD" } }, "shop_money": { "name": "shop_money", "description": "The tax amount information recorded by the store.", "type": "object", "properties": { "amount": { "name": "amount", "description": "The tax amount. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" } }, "example": { "amount": "8.00", "currency_code": "USD" } } }, "example": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } } }, "total_tip_received": { "name": "total_tip_received", "description": "The tip amount in the store currency. The value is rounded to two decimal places. ", "type": "string", "example": "8.00" }, "total_tip_received_set": { "name": "total_tip_received_set", "description": "The tip amount, displayed in both the store currency and the buyer currency.", "type": "object", "properties": { "presentment_money": { "name": "presentment_money", "description": "The tip amount information presented to the buyer. ", "type": "object", "properties": { "amount": { "name": "amount", "description": "The tip amount. The value is rounded to two decimal places. ", "type": "string", "example": "10.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" } }, "example": { "amount": "10.00", "currency_code": "USD" } }, "shop_money": { "name": "shop_money", "description": "The tip amount information recorded by the store.", "type": "object", "properties": { "amount": { "name": "amount", "description": "The tip amount. The value is rounded to two decimal places. ", "type": "string", "example": "70.00" }, "currency_code": { "name": "currency_code", "description": "A three-letter currency code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. ", "type": "string", "example": "USD" } }, "example": { "amount": "70.00", "currency_code": "USD" } } }, "example": { "presentment_money": { "amount": "10.00", "currency_code": "USD" }, "shop_money": { "amount": "70.00", "currency_code": "USD" } } }, "total_weight": { "name": "total_weight", "description": "The total weight of products in grams(g).", "type": "double", "example": 1 }, "updated_at": { "name": "updated_at", "description": "The date and time when the order was updated. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).", "type": "string", "example": "2021-08-16T08:27:57+00:00" }, "user_id": { "name": "user_id", "description": "Buyer ID.", "type": "string", "example": "4201057495" }, "utm_parameters": { "name": "utm_parameters", "description": "Parameters specifically designed for the advertising business, used for ad attribution calculation. \n\n:::danger \t\n**DEPRECATED**：This parameter is deprecated from API version v20251201. Please fetch data from the [Get order attribution in bulk](https://developer.shopline.com/docs/admin-rest-api/order/order-management/get-order-attribution-in-bulk.md) API. \n:::", "type": "string" } }, "example": { "adjust_price": "8.00", "adjust_price_set": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } }, "billing_address": { "address1": "Address 1", "address2": "Address 2", "city": "New York", "company": "New company name", "country": "USA", "country_code": "US", "first_name": "Tom", "last_name": "Washington", "name": "test1001", "phone": "13100000000", "province": "California", "province_code": "4200006", "standard_province_code": null, "zip": "92503" }, "browser_ip": "157.119.232.35", "buyer_note": "message", "cancel_reason": "I don't want to buy it.", "cancelled_at": "2012-05-01T14:22:25-04:00", "cart_token": "c2c4a58186b9d96395d7e6b5c2969577", "checkout_id": "2404785166526352972864", "checkout_token": "c2c4a58186b9d96395d7e6b5c2969577", "client_details": { "browser_ip": "157.119.232.35", "session_hash": "c2c4a58186b9d96395d7e6b5c2969577", "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/106.0.0.0 Safari/537.36" }, "company": { "id": "1005619945158043247856", "location_id": "3005619945158043247856", "tax_registration_id": "213213" }, "contract_seq": "3005619945158043247856", "created_at": "2021-08-16T08:27:57+00:00", "credit_limit": { "credit_limit_currency": "USD", "is_credit_limit": null, "outstanding_credit_limit": "1.00", "total_credit_limit": "1.00" }, "currency": "USD", "current_subtotal_price": "78.0", "current_subtotal_price_set": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } }, "current_total_discounts": "1.00", "current_total_discounts_set": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } }, "current_total_duties_set": { "presentment_money": { "amount": "8.88", "currency_code": "USD" }, "shop_money": { "amount": "8.88", "currency_code": "USD" } }, "current_total_price": "60.0", "current_total_price_set": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } }, "current_total_tax": "1.00", "current_total_tax_set": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } }, "customer": { "addresses": { "address1": "Wanda", "address2": "65788", "city": "Yangquan City", "country": "China", "country_code": "US", "first_name": "Tom", "last_name": "Washington", "name": "D203", "phone": "13100000000", "province": "Shanxi Province", "province_code": "ASD", "zip": "521000" }, "area_code": "+86", "created_at": "2024-08-31T02:20:26+08:00", "currency": "USD", "email": "Washingtontest@gmail.com", "first_name": "Tom", "id": "4201057495", "last_name": "Washington", "phone": "13100000000", "updated_at": "2022-11-04T10:18:46+00:00" }, "customer_locale": "enCA", "deduct_member_point_amount": "8.00", "deduct_member_point_amount_set": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "1.00", "currency_code": "USD" } }, "discount_applications": [ {} ], "discount_codes": [ {} ], "email": "hok@shoplineapp.com", "financial_status": null, "fulfillment_status": null, "fulfillments": [ {} ], "hidden_order": null, "id": "21050224312121887324667162", "landing_site": "https://www.url.com", "line_items": [ {} ], "locations": [ {} ], "name": "test1001", "note": "Notes", "note_attributes": [ {} ], "order_at": "2021-08-16T08:27:57+00:00", "order_source": null, "order_status_url": null, "payment_details": [ {} ], "payment_gateway_names": [ "SLpayments" ], "payment_terms": { "created_at": "2024-06-05 08:00:00", "due_in_days": 2, "id": "6497210673894431747", "overdue": null, "payment_schedules": null, "payment_terms_name": "Due on receipt", "payment_terms_type": null, "updated_at": "2024-06-05 08:00:00" }, "phone": "18978789878", "po_number": null, "pos_location_id": "5327026538935748524", "presentment_currency": "USD", "processed_at": "2023-04-12T22:59:52+08:00", "processed_user_id": "4201057495", "referring_site": "https://www.referringSite.com", "refunds": [ {} ], "service": null, "shipping_address": { "address1": "Address 1", "address2": "Address 2", "city": "City", "company": "Company Name", "country": "China", "country_code": "US", "delivery_store_code": "1001", "delivery_store_name": "Store name", "district": "Panyu District", "district_code": "521000", "first_name": "Tom", "last_name": "Washington", "latitude": "15", "longitude": "41", "name": "Tom.Washington", "phone": "13100000000", "province": "Guangdong Province", "province_code": "510000", "standard_province_code": null, "zip": "521000" }, "shipping_lines": [ {} ], "source_identifier": null, "source_name": null, "source_url": null, "status": null, "store_id": "1644828244663", "subtotal_price": "8.00", "subtotal_price_set": { "presentment_money": { "amount": "1.00", "currency_code": "USD" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } }, "tags": "Label", "tax_description": null, "tax_lines": [ {} ], "tax_number": null, "tax_type": null, "taxes_included": null, "total_discounts": "3.25", "total_discounts_set": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } }, "total_line_items_price": "8.00", "total_line_items_price_set": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } }, "total_outstanding": "8.00", "total_shipping_price_set": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } }, "total_tax": "8.00", "total_tax_set": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } }, "total_tip_received": "8.00", "total_tip_received_set": { "presentment_money": { "amount": "10.00", "currency_code": "USD" }, "shop_money": { "amount": "70.00", "currency_code": "USD" } }, "total_weight": 1, "updated_at": "2021-08-16T08:27:57+00:00", "user_id": "4201057495", "utm_parameters": null } }, "example": [] } }, "example": { "orders": [] } }, "examples": { "Get orders": { "description": "Get order details in bulk based on specified request information. For example, you can get orders by the order creation time or update time, or specify an order ID to get details for a single order. ", "value": { "orders": [ { "adjust_price": "0.00", "adjust_price_set": { "presentment_money": { "amount": "0.00", "currency_code": "USD" }, "shop_money": { "amount": "0.00", "currency_code": "USD" } }, "billing_address": { "address1": "9800+Fredericksburg+Road+Northwest+Side", "address2": "San+Antonio", "city": "Air Force Academy", "company": "", "country": "United States", "country_code": "US", "first_name": "FireXuan_CN", "last_name": "Addr-US", "name": "FireXuan_CN Addr-US", "phone": "13212345678", "province": "New York", "province_code": "4200037", "zip": "12000" }, "browser_ip": "157.119.232.36", "buyer_note": "", "cancel_reason": "", "cancelled_at": "2024-10-30T18:07:25+08:00", "cart_token": null, "checkout_id": "2406696682020612513424", "checkout_token": "c2c4a6696682a2a6b2f1d4c48396a1b3", "client_details": { "browser_ip": "157.119.232.36", "session_hash": "a3980801-295b-46ea-a331-b43b2e0f7758", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/127.0.0.0 Safari/537.36" }, "company": null, "contract_seq": null, "created_at": "2024-10-21T11:32:56+08:00", "credit_limit": null, "currency": "USD", "current_subtotal_price": "200.00", "current_subtotal_price_set": { "presentment_money": { "amount": "200.00", "currency_code": "USD" }, "shop_money": { "amount": "200.00", "currency_code": "USD" } }, "current_total_discounts": "0.00", "current_total_discounts_set": { "presentment_money": { "amount": "0.00", "currency_code": "USD" }, "shop_money": { "amount": "0.00", "currency_code": "USD" } }, "current_total_duties_set": null, "current_total_price": "274.72", "current_total_price_set": { "presentment_money": { "amount": "274.72", "currency_code": "USD" }, "shop_money": { "amount": "274.72", "currency_code": "USD" } }, "current_total_tax": "14.72", "current_total_tax_set": { "presentment_money": { "amount": "14.72", "currency_code": "USD" }, "shop_money": { "amount": "14.72", "currency_code": "USD" } }, "customer": { "addresses": { "address1": "9800+Fredericksburg+Road+Northwest+Side", "address2": "", "city": "Air Force Academy", "country": "United States", "country_code": "US", "first_name": "FireXuan_CN", "last_name": "Addr-US", "name": "FireXuan_CN Addr-US", "phone": "13212345678", "province": "New York", "province_code": "4200037", "zip": "12000" }, "area_code": null, "created_at": "2024-04-19T10:23:49+08:00", "currency": "USD", "email": "bing+448@shopline.com", "first_name": "FireXuan_CN", "id": "4600604163", "last_name": "FireXuan_CN Addr-US", "phone": null, "updated_at": null }, "customer_locale": "enUS", "deduct_member_point_amount": "0.00", "deduct_member_point_amount_set": { "presentment_money": { "amount": "0.00", "currency_code": "USD" }, "shop_money": { "amount": "0.00", "currency_code": "USD" } }, "discount_applications": [], "discount_codes": [], "email": "bing+448@shopline.com", "financial_status": "unpaid", "fulfillment_status": "null", "fulfillments": [ { "created_at": "2024-10-24T13:33:49+08:00", "id": "22067011542659047173883424", "line_items": [ { "attribute": "", "fulfillable_quantity": 0, "fulfillment_quantity": 1, "fulfillment_service": "", "fulfillment_status": "fulfilled", "grams": 28350, "id": "7432", "image_url": "https://d2n979dmt31clo.cloudfront.net/image/store/3300003215/219/49bde8461ca648ab966be7505f6cf2f4.jpeg?w=500&h=375", "location_id": "5479245311502721516", "name": "TW and US Goods", "price": "200.00", "price_set": { "presentment_money": { "amount": "200.00", "currency_code": "USD" }, "shop_money": { "amount": "200.00", "currency_code": "USD" } }, "product_id": "16066882414538428437450910", "quantity": 1, "requires_shipping": true, "sku": "T20200925200122", "tax_lines": [ { "price": "11.32", "price_set": { "presentment_money": { "amount": "11.32", "currency_code": "USD" }, "shop_money": { "amount": "11.32", "currency_code": "USD" } }, "rate": 0.0566, "title": "product_tax" }, { "price": "3.40", "price_set": { "presentment_money": { "amount": "3.40", "currency_code": "USD" }, "shop_money": { "amount": "3.40", "currency_code": "USD" } }, "rate": 0.0566, "title": "express_tax" } ], "taxable": true, "title": "TW and US Goods", "variant_id": "18066882414545307096080910", "variant_title": "", "vendor": "C03-Test Title" } ], "name": "TU202132481-F1", "order_id": "21066966839327957070363424", "shipment_status": null, "status": "cancelled", "tracking_company": "", "tracking_number": "123", "tracking_url": "", "updated_at": "2024-10-24T14:01:23+08:00" }, { "created_at": "2024-10-24T14:01:30+08:00", "id": "22067011821330785972073424", "line_items": [ { "attribute": "", "fulfillable_quantity": 0, "fulfillment_quantity": 1, "fulfillment_service": "", "fulfillment_status": "fulfilled", "grams": 28350, "id": "7432", "image_url": "https://d2n979dmt31clo.cloudfront.net/image/store/3300003215/219/49bde8461ca648ab966be7505f6cf2f4.jpeg?w=500&h=375", "location_id": "5479245311502721516", "name": "TW and US Goods", "price": "200.00", "price_set": { "presentment_money": { "amount": "200.00", "currency_code": "USD" }, "shop_money": { "amount": "200.00", "currency_code": "USD" } }, "product_id": "16066882414538428437450910", "quantity": 1, "requires_shipping": true, "sku": "T20200925200122", "tax_lines": [ { "price": "11.32", "price_set": { "presentment_money": { "amount": "11.32", "currency_code": "USD" }, "shop_money": { "amount": "11.32", "currency_code": "USD" } }, "rate": 0.0566, "title": "product_tax" }, { "price": "3.40", "price_set": { "presentment_money": { "amount": "3.40", "currency_code": "USD" }, "shop_money": { "amount": "3.40", "currency_code": "USD" } }, "rate": 0.0566, "title": "express_tax" } ], "taxable": true, "title": "TW and US Goods", "variant_id": "18066882414545307096080910", "variant_title": "", "vendor": "C03-Test Title" } ], "name": "TU202132481-F2", "order_id": "21066966839327957070363424", "shipment_status": null, "status": null, "tracking_company": "", "tracking_number": "", "tracking_url": "", "updated_at": "2024-10-24T14:01:38+08:00" } ], "hidden_order": false, "id": "21066966839327957070363424", "landing_site": "https://bingtang.asia/zh-hans-cn/", "line_items": [ { "attribute": "", "country_code_of_origin": null, "customized_attributes": null, "discount_allocations": null, "duties": [], "fulfillable_quantity": 0, "fulfillment_service": "", "fulfillment_status": "fulfilled", "gift_card": false, "grams": 28350, "harmonized_system_code": "988777788999", "id": "7432", "image_url": "https://d2n979dmt31clo.cloudfront.net/image/store/3300003215/219/49bde8461ca648ab966be7505f6cf2f4.jpeg?w=500&h=375", "location_id": "5479245311502721516", "name": "TW and US Goods", "price": "200.00", "price_set": { "presentment_money": { "amount": "200.00", "currency_code": "USD" }, "shop_money": { "amount": "200.00", "currency_code": "USD" } }, "product_id": "16066882414538428437450910", "properties": null, "quantity": 1, "requires_shipping": true, "sku": "T20200925200122", "tags": "rocketbig", "tax_lines": [ { "price": "11.32", "price_set": { "presentment_money": { "amount": "11.32", "currency_code": "USD" }, "shop_money": { "amount": "11.32", "currency_code": "USD" } }, "rate": 0.0566, "title": "product_tax", "type": "product_tax" }, { "price": "3.40", "price_set": { "presentment_money": { "amount": "3.40", "currency_code": "USD" }, "shop_money": { "amount": "3.40", "currency_code": "USD" } }, "rate": 0.0566, "title": "express_tax", "type": "shipping_tax" } ], "taxable": true, "title": "TW and US Goods", "variant_id": "18066882414545307096080910", "variant_title": "", "vendor": "C03-Test Title" } ], "locations": [ { "address": "12 Stout Street", "address_add": "", "city": "Paterson", "country": "United States", "country_code": "US", "district": "", "location_id": "5479245311502721516", "name": "United States - Texas (9800 Fredericksburg Road, San Antonio, Texas 78288, United States)", "phone": "13845678909", "province": "New Jersey", "town": null, "type": "productLocation", "zip": "07522" } ], "name": "TU202132481", "note": null, "note_attributes": [], "order_at": "2024-10-21T11:32:56+08:00", "order_source": "web", "order_status_url": null, "payment_details": [ { "create_time": "2024-10-21T11:32:56+08:00", "gateway": "COD", "pay_amount": 274.72, "pay_channel": "customPay", "pay_channel_deal_id": null, "pay_merchant_email": null, "pay_merchant_id": null, "pay_merchant_order_id": null, "pay_seq": "23066966839379630895653424", "pay_status": "unpaid", "processed_at": null, "settle_currency": "USD", "settle_pay_amount": 274.72, "status_code": null, "status_msg": null } ], "payment_gateway_names": [ "customPay" ], "payment_terms": null, "phone": null, "po_number": null, "pos_location_id": null, "presentment_currency": "USD", "processed_at": "2024-10-21T11:32:56+08:00", "processed_user_id": "4600604163", "referring_site": "", "refunds": [ { "created_at": "2024-10-30T18:07:25+08:00", "id": "2606710127006922054812", "note": null, "order_adjustments": [ { "amount": "60.00", "amount_set": { "presentment_money": { "amount": 60, "currency_code": "USD" }, "shop_money": { "amount": 60, "currency_code": "USD" } }, "id": "RAP6710127008012573855", "kind": "shipping_refund", "order_id": "21066966839327957070363424", "reason": "Shipping refund", "refund_id": "2706710127007089826973", "tax_amount": "3.40", "tax_amount_set": { "presentment_money": { "amount": 3.4, "currency_code": "USD" }, "shop_money": { "amount": 3.4, "currency_code": "USD" } } }, { "amount": "274.72", "amount_set": { "presentment_money": { "amount": 274.72, "currency_code": "USD" }, "shop_money": { "amount": 274.72, "currency_code": "USD" } }, "id": "RAP6710127008079682720", "kind": "refund_discrepancy", "order_id": "21066966839327957070363424", "reason": "Refund discrepancy", "refund_id": "2706710127007089826973", "tax_amount": "14.72", "tax_amount_set": { "presentment_money": { "amount": 14.72, "currency_code": "USD" }, "shop_money": { "amount": 14.72, "currency_code": "USD" } } } ], "order_id": "21066966839327957070363424", "processed_at": null, "refund_line_items": [ { "id": "RDP6710127007224044702", "line_item": { "attribute": "", "fulfillable_quantity": 0, "fulfillment_service": "", "fulfillment_status": "fulfilled", "grams": 28350, "id": "7432", "name": "TW and US Goods", "price": "200.00", "price_set": { "presentment_money": { "amount": "200.00", "currency_code": "USD" }, "shop_money": { "amount": "200.00", "currency_code": "USD" } }, "product_id": "16066882414538428437450910", "quantity": 1, "requires_shipping": true, "sku": "T20200925200122", "tax_lines": [ { "price": "11.32", "price_set": { "presentment_money": { "amount": "11.32", "currency_code": "USD" }, "shop_money": { "amount": "11.32", "currency_code": "USD" } }, "rate": 0.0566, "title": "product_tax" }, { "price": "3.40", "price_set": { "presentment_money": { "amount": "3.40", "currency_code": "USD" }, "shop_money": { "amount": "3.40", "currency_code": "USD" } }, "rate": 0.0566, "title": "express_tax" } ], "taxable": true, "title": "TW and US Goods", "variant_id": "18066882414545307096080910", "variant_title": "", "vendor": "C03-Test Title" }, "line_item_id": "7432", "quantity": 1, "restock_type": "return", "subtotal": 211.32, "subtotal_set": { "presentment_money": { "amount": "211.32", "currency_code": "USD" }, "shop_money": { "amount": "211.32", "currency_code": "USD" } }, "total_tax": 11.32, "total_tax_set": { "presentment_money": { "amount": "11.32", "currency_code": "USD" }, "shop_money": { "amount": "11.32", "currency_code": "USD" } } } ], "transactions": [], "user_id": "4600604163" } ], "service": null, "shipping_address": { "address1": "9800+Fredericksburg+Road+Northwest+Side", "address2": "", "city": "Air Force Academy", "company": "", "country": "United States", "country_code": "US", "delivery_store_code": null, "delivery_store_name": null, "district": "", "district_code": "", "first_name": "FireXuan_CN", "last_name": "Addr-US", "latitude": null, "longitude": null, "name": "FireXuan_CN Addr-US", "phone": "13212345678", "province": "New York", "province_code": "4200037", "zip": "12000" }, "shipping_lines": [ { "code": "Local delivery", "discount_allocations": null, "discounted_price": null, "discounted_price_set": null, "phone": "00113212345678", "price": "60.00", "price_set": { "presentment_money": { "amount": "60.00", "currency_code": "USD" }, "shop_money": { "amount": "60.00", "currency_code": "USD" } }, "requested_fulfillment_service_id": null, "shipping_price": "60.00", "shipping_price_set": { "presentment_money": { "amount": "60.00", "currency_code": "USD" }, "shop_money": { "amount": "60.00", "currency_code": "USD" } }, "source": null, "tax_lines": [ { "price": "3.40", "price_set": { "presentment_money": { "amount": "3.40", "currency_code": "USD" }, "shop_money": { "amount": "3.40", "currency_code": "USD" } }, "rate": 0.06, "title": "express_tax" } ], "title": "Local delivery" } ], "source_identifier": "", "source_name": "", "source_url": "", "status": "cancelled", "store_id": "219", "subtotal_price": "200.0", "subtotal_price_set": { "presentment_money": { "amount": "200.0", "currency_code": "USD" }, "shop_money": { "amount": "200.0", "currency_code": "USD" } }, "tags": null, "tax_lines": [ { "name": "GST", "price": "11.32", "price_set": { "presentment_money": { "amount": "11.32", "currency_code": "USD" }, "shop_money": { "amount": "11.32", "currency_code": "USD" } }, "rate": 0.0566, "title": "product_tax" }, { "name": "GST", "price": "3.40", "price_set": { "presentment_money": { "amount": "3.40", "currency_code": "USD" }, "shop_money": { "amount": "3.40", "currency_code": "USD" } }, "rate": 0.0566, "title": "express_tax" } ], "tax_number": "45345", "tax_type": "Tax Identification Number", "taxes_included": true, "total_discounts": "0.00", "total_discounts_set": { "presentment_money": { "amount": "0.00", "currency_code": "USD" }, "shop_money": { "amount": "0.00", "currency_code": "USD" } }, "total_line_items_price": "200.00", "total_line_items_price_set": { "presentment_money": { "amount": "200.00", "currency_code": "USD" }, "shop_money": { "amount": "200.00", "currency_code": "USD" } }, "total_outstanding": "274.72", "total_shipping_price_set": { "presentment_money": { "amount": "60.00", "currency_code": "USD" }, "shop_money": { "amount": "60.00", "currency_code": "USD" } }, "total_tax": "14.72", "total_tax_set": { "presentment_money": { "amount": "14.72", "currency_code": "USD" }, "shop_money": { "amount": "14.72", "currency_code": "USD" } }, "total_tip_received": "0.00", "total_tip_received_set": { "presentment_money": { "amount": "0.00", "currency_code": "USD" }, "shop_money": { "amount": "0.00", "currency_code": "USD" } }, "total_weight": 28350, "updated_at": "2024-10-30T18:07:25+08:00", "user_id": "4600604163", "utm_parameters": "{\"sl_source_ad_platform\":\"\",\"sl_source_campaign_id\":\"\",\"sl_source_placement\":\"\",\"sl_source_ad_id\":\"\",\"utm_source\":\"\",\"utm_medium\":\"\",\"utm_campaign\":\"\",\"utm_adset\":\"\",\"utm_ad\":\"\",\"utm_content\":\"\",\"utm_term\":\"\"}" }, { "adjust_price": "0.00", "adjust_price_set": { "presentment_money": { "amount": "0.00", "currency_code": "USD" }, "shop_money": { "amount": "0.00", "currency_code": "USD" } }, "billing_address": { "address1": "8899 Garfield Street, xihuanwann", "address2": "xihuanwann", "city": "Riverside", "company": "", "country": "US", "country_code": "US", "first_name": "lucous", "last_name": "toba", "name": "lucous toba", "phone": "01066666666", "province": "California", "province_code": "4200006", "zip": "92504" }, "browser_ip": "183.90.187.195", "buyer_note": null, "cancel_reason": "", "cancelled_at": "2024-11-05T16:28:34+08:00", "cart_token": null, "checkout_id": null, "checkout_token": null, "client_details": { "browser_ip": "183.90.187.195", "session_hash": null, "user_agent": null }, "company": null, "contract_seq": null, "created_at": "2024-11-05T15:17:21+08:00", "credit_limit": null, "currency": "USD", "current_subtotal_price": "1000.00", "current_subtotal_price_set": { "presentment_money": { "amount": "1000.00", "currency_code": "USD" }, "shop_money": { "amount": "1000.00", "currency_code": "USD" } }, "current_total_discounts": "0.00", "current_total_discounts_set": { "presentment_money": { "amount": "0.00", "currency_code": "USD" }, "shop_money": { "amount": "0.00", "currency_code": "USD" } }, "current_total_duties_set": null, "current_total_price": "1056.60", "current_total_price_set": { "presentment_money": { "amount": "1056.60", "currency_code": "USD" }, "shop_money": { "amount": "1056.60", "currency_code": "USD" } }, "current_total_tax": "56.60", "current_total_tax_set": { "presentment_money": { "amount": "56.60", "currency_code": "USD" }, "shop_money": { "amount": "56.60", "currency_code": "USD" } }, "customer": { "addresses": { "address1": "8899 Garfield Street, xihuanwann", "address2": "xihuanwann", "city": "Riverside", "country": "US", "country_code": "US", "first_name": "lucous", "last_name": "toba", "name": "lucous toba", "phone": "01066666666", "province": "California", "province_code": "4200006", "zip": "92504" }, "area_code": "86", "created_at": "2023-12-04T15:58:39+08:00", "currency": "USD", "email": "xubihui@shopline.com", "first_name": "", "id": "4217351534", "last_name": "xubihui", "phone": "13718003611", "updated_at": null }, "customer_locale": "enUS", "deduct_member_point_amount": "0.00", "deduct_member_point_amount_set": { "presentment_money": { "amount": "0.00", "currency_code": "USD" }, "shop_money": { "amount": "0.00", "currency_code": "USD" } }, "discount_applications": [], "discount_codes": [], "email": "xubihui@shopline.com", "financial_status": "refunded", "fulfillment_status": "null", "fulfillments": [ { "created_at": "2024-11-05T16:24:49+08:00", "id": "22067187210199546020099591", "line_items": [ { "attribute": null, "fulfillable_quantity": 0, "fulfillment_quantity": 5, "fulfillment_service": "", "fulfillment_status": "null", "grams": null, "id": "8434", "image_url": null, "location_id": "5479246478190322184", "name": "Performance Location Split Test Products", "price": "100.00", "price_set": { "presentment_money": { "amount": "100.00", "currency_code": "USD" }, "shop_money": { "amount": "100.00", "currency_code": "USD" } }, "product_id": "16067186511521277740520910", "quantity": 10, "requires_shipping": true, "sku": "11", "tax_lines": [ { "price": "56.60", "price_set": { "presentment_money": { "amount": "56.60", "currency_code": "USD" }, "shop_money": { "amount": "56.60", "currency_code": "USD" } }, "rate": 0.0566, "title": "product_tax" }, { "price": "0.00", "price_set": { "presentment_money": { "amount": "0.00", "currency_code": "USD" }, "shop_money": { "amount": "0.00", "currency_code": "USD" } }, "rate": 0, "title": "express_tax" } ], "taxable": true, "title": "Performance Location Split Test Products", "variant_id": "18067186511526478677540910", "variant_title": null, "vendor": null } ], "name": "TU202132585-F1", "order_id": "21067186531146929695929591", "shipment_status": null, "status": "cancelled", "tracking_company": "", "tracking_number": "", "tracking_url": "", "updated_at": "2024-11-05T16:25:40+08:00" }, { "created_at": "2024-11-05T16:24:56+08:00", "id": "22067187211539877806349591", "line_items": [ { "attribute": null, "fulfillable_quantity": 0, "fulfillment_quantity": 5, "fulfillment_service": "", "fulfillment_status": "null", "grams": null, "id": "8434", "image_url": null, "location_id": "5479246478190322184", "name": "Performance Location Split Test Products", "price": "100.00", "price_set": { "presentment_money": { "amount": "100.00", "currency_code": "USD" }, "shop_money": { "amount": "100.00", "currency_code": "USD" } }, "product_id": "16067186511521277740520910", "quantity": 10, "requires_shipping": true, "sku": "11", "tax_lines": [ { "price": "56.60", "price_set": { "presentment_money": { "amount": "56.60", "currency_code": "USD" }, "shop_money": { "amount": "56.60", "currency_code": "USD" } }, "rate": 0.0566, "title": "product_tax" }, { "price": "0.00", "price_set": { "presentment_money": { "amount": "0.00", "currency_code": "USD" }, "shop_money": { "amount": "0.00", "currency_code": "USD" } }, "rate": 0, "title": "express_tax" } ], "taxable": true, "title": "Performance Location Split Test Products", "variant_id": "18067186511526478677540910", "variant_title": null, "vendor": null } ], "name": "TU202132585-F2", "order_id": "21067186531146929695929591", "shipment_status": null, "status": "cancelled", "tracking_company": "", "tracking_number": "", "tracking_url": "", "updated_at": "2024-11-05T16:26:05+08:00" }, { "created_at": "2024-11-05T16:27:07+08:00", "id": "22067187233522896159009591", "line_items": [ { "attribute": null, "fulfillable_quantity": 0, "fulfillment_quantity": 5, "fulfillment_service": "", "fulfillment_status": "null", "grams": null, "id": "8434", "image_url": null, "location_id": "5479246478190322184", "name": "Performance Location Split Test Products", "price": "100.00", "price_set": { "presentment_money": { "amount": "100.00", "currency_code": "USD" }, "shop_money": { "amount": "100.00", "currency_code": "USD" } }, "product_id": "16067186511521277740520910", "quantity": 10, "requires_shipping": true, "sku": "11", "tax_lines": [ { "price": "56.60", "price_set": { "presentment_money": { "amount": "56.60", "currency_code": "USD" }, "shop_money": { "amount": "56.60", "currency_code": "USD" } }, "rate": 0.0566, "title": "product_tax" }, { "price": "0.00", "price_set": { "presentment_money": { "amount": "0.00", "currency_code": "USD" }, "shop_money": { "amount": "0.00", "currency_code": "USD" } }, "rate": 0, "title": "express_tax" } ], "taxable": true, "title": "Performance Location Split Test Products", "variant_id": "18067186511526478677540910", "variant_title": null, "vendor": null } ], "name": "TU202132585-F3", "order_id": "21067186531146929695929591", "shipment_status": null, "status": "cancelled", "tracking_company": "", "tracking_number": "", "tracking_url": "", "updated_at": "2024-11-05T16:27:58+08:00" }, { "created_at": "2024-11-05T16:27:15+08:00", "id": "22067187234793938043179591", "line_items": [ { "attribute": null, "fulfillable_quantity": 0, "fulfillment_quantity": 5, "fulfillment_service": "", "fulfillment_status": "null", "grams": null, "id": "8434", "image_url": null, "location_id": "5479246478190322184", "name": "Performance Location Split Test Products", "price": "100.00", "price_set": { "presentment_money": { "amount": "100.00", "currency_code": "USD" }, "shop_money": { "amount": "100.00", "currency_code": "USD" } }, "product_id": "16067186511521277740520910", "quantity": 10, "requires_shipping": true, "sku": "11", "tax_lines": [ { "price": "56.60", "price_set": { "presentment_money": { "amount": "56.60", "currency_code": "USD" }, "shop_money": { "amount": "56.60", "currency_code": "USD" } }, "rate": 0.0566, "title": "product_tax" }, { "price": "0.00", "price_set": { "presentment_money": { "amount": "0.00", "currency_code": "USD" }, "shop_money": { "amount": "0.00", "currency_code": "USD" } }, "rate": 0, "title": "express_tax" } ], "taxable": true, "title": "Performance Location Split Test Products", "variant_id": "18067186511526478677540910", "variant_title": null, "vendor": null } ], "name": "TU202132585-F4", "order_id": "21067186531146929695929591", "shipment_status": null, "status": "cancelled", "tracking_company": "", "tracking_number": "", "tracking_url": "", "updated_at": "2024-11-05T16:28:13+08:00" } ], "hidden_order": false, "id": "21067186531146929695929591", "landing_site": null, "line_items": [ { "attribute": null, "country_code_of_origin": null, "customized_attributes": null, "discount_allocations": null, "duties": [], "fulfillable_quantity": 0, "fulfillment_service": "", "fulfillment_status": "null", "gift_card": false, "grams": null, "harmonized_system_code": null, "id": "8434", "image_url": null, "location_id": "5479246478190322184", "name": "Performance Location Split Test Products", "price": "100.00", "price_set": { "presentment_money": { "amount": "100.00", "currency_code": "USD" }, "shop_money": { "amount": "100.00", "currency_code": "USD" } }, "product_id": "16067186511521277740520910", "properties": null, "quantity": 10, "requires_shipping": true, "sku": "11", "tags": "", "tax_lines": [ { "price": "56.60", "price_set": { "presentment_money": { "amount": "56.60", "currency_code": "USD" }, "shop_money": { "amount": "56.60", "currency_code": "USD" } }, "rate": 0.0566, "title": "product_tax", "type": "product_tax" }, { "price": "0.00", "price_set": { "presentment_money": { "amount": "0.00", "currency_code": "USD" }, "shop_money": { "amount": "0.00", "currency_code": "USD" } }, "rate": 0, "title": "express_tax", "type": "shipping_tax" } ], "taxable": true, "title": "Performance Location Split Test Products", "variant_id": "18067186511526478677540910", "variant_title": null, "vendor": null } ], "locations": [ { "address": "12 Stout Street", "address_add": "", "city": "Paterson", "country": "US", "country_code": "US", "district": "", "location_id": "5479245311502721516", "name": "United States - Texas (9800 Fredericksburg Road, San Antonio, Texas 78288, United States)", "phone": "13845678909", "province": "New Jersey", "town": null, "type": "productLocation", "zip": "07522" }, { "address": "600 State Drive", "address_add": "", "city": "Los Angeles", "country": "US", "country_code": "US", "district": "", "location_id": "5479246478190322184", "name": "US - California (600 State Drive, Los Angeles, California 90037, US)", "phone": "13909876789", "province": "California", "town": null, "type": "productLocation", "zip": "90037" } ], "name": "TU202132585", "note": null, "note_attributes": [], "order_at": "2024-11-05T15:17:21+08:00", "order_source": null, "order_status_url": null, "payment_details": [ { "create_time": "2024-11-05T15:17:21+08:00", "gateway": "KOMOJU Other", "pay_amount": 105.66, "pay_channel": "KomojuOther", "pay_channel_deal_id": null, "pay_merchant_email": null, "pay_merchant_id": null, "pay_merchant_order_id": null, "pay_seq": "23067186531215884053699591", "pay_status": "unpaid", "processed_at": null, "settle_currency": "USD", "settle_pay_amount": 105.66, "status_code": null, "status_msg": null }, { "create_time": "2024-11-05T16:26:37+08:00", "gateway": "codPay", "pay_amount": 1056.6, "pay_channel": "codPay", "pay_channel_deal_id": null, "pay_merchant_email": null, "pay_merchant_id": null, "pay_merchant_order_id": null, "pay_seq": "2306718722843319214107", "pay_status": "paid", "processed_at": "2024-11-05T16:26:37+08:00", "settle_currency": "USD", "settle_pay_amount": 1056.6, "status_code": null, "status_msg": null } ], "payment_gateway_names": [ "KomojuOther", "codPay" ], "payment_terms": null, "phone": "13718003611", "po_number": null, "pos_location_id": null, "presentment_currency": "USD", "processed_at": "2024-11-05T15:17:21+08:00", "processed_user_id": "4217351534", "referring_site": null, "refunds": [ { "created_at": "2024-11-05T16:28:35+08:00", "id": "2606718724816303038494", "note": null, "order_adjustments": [], "order_id": "21067186531146929695929591", "processed_at": null, "refund_line_items": [ { "id": "RDP6718724821134876704", "line_item": { "attribute": null, "fulfillable_quantity": 0, "fulfillment_service": "", "fulfillment_status": "null", "grams": null, "id": "8434", "name": "Performance Location Split Test Products", "price": "100.00", "price_set": { "presentment_money": { "amount": "100.00", "currency_code": "USD" }, "shop_money": { "amount": "100.00", "currency_code": "USD" } }, "product_id": "16067186511521277740520910", "quantity": 10, "requires_shipping": true, "sku": "11", "tax_lines": [ { "price": "56.60", "price_set": { "presentment_money": { "amount": "56.60", "currency_code": "USD" }, "shop_money": { "amount": "56.60", "currency_code": "USD" } }, "rate": 0.0566, "title": "product_tax" }, { "price": "0.00", "price_set": { "presentment_money": { "amount": "0.00", "currency_code": "USD" }, "shop_money": { "amount": "0.00", "currency_code": "USD" } }, "rate": 0, "title": "express_tax" } ], "taxable": true, "title": "Performance Location Split Test Products", "variant_id": "18067186511526478677540910", "variant_title": null, "vendor": null }, "line_item_id": "8434", "quantity": 5, "restock_type": "return", "subtotal": 528.3, "subtotal_set": { "presentment_money": { "amount": "528.30", "currency_code": "USD" }, "shop_money": { "amount": "528.30", "currency_code": "USD" } }, "total_tax": 28.3, "total_tax_set": { "presentment_money": { "amount": "28.30", "currency_code": "USD" }, "shop_money": { "amount": "28.30", "currency_code": "USD" } } }, { "id": "RDP6718724822997147681", "line_item": { "attribute": null, "fulfillable_quantity": 0, "fulfillment_service": "", "fulfillment_status": "null", "grams": null, "id": "8434", "name": "Performance Location Split Test Products", "price": "100.00", "price_set": { "presentment_money": { "amount": "100.00", "currency_code": "USD" }, "shop_money": { "amount": "100.00", "currency_code": "USD" } }, "product_id": "16067186511521277740520910", "quantity": 10, "requires_shipping": true, "sku": "11", "tax_lines": [ { "price": "56.60", "price_set": { "presentment_money": { "amount": "56.60", "currency_code": "USD" }, "shop_money": { "amount": "56.60", "currency_code": "USD" } }, "rate": 0.0566, "title": "product_tax" }, { "price": "0.00", "price_set": { "presentment_money": { "amount": "0.00", "currency_code": "USD" }, "shop_money": { "amount": "0.00", "currency_code": "USD" } }, "rate": 0, "title": "express_tax" } ], "taxable": true, "title": "Performance Location Split Test Products", "variant_id": "18067186511526478677540910", "variant_title": null, "vendor": null }, "line_item_id": "8434", "quantity": 5, "restock_type": "return", "subtotal": 528.3, "subtotal_set": { "presentment_money": { "amount": "528.30", "currency_code": "USD" }, "shop_money": { "amount": "528.30", "currency_code": "USD" } }, "total_tax": 28.3, "total_tax_set": { "presentment_money": { "amount": "28.30", "currency_code": "USD" }, "shop_money": { "amount": "28.30", "currency_code": "USD" } } } ], "transactions": [ { "amount": "1056.60", "created_at": "2024-11-05T16:28:35+08:00", "currency": "USD", "id": "2306718722843319214107", "kind": "refund", "order_id": "21067186531146929695929591", "processed_at": null, "settle_amount": "1056.60", "settle_currency": "USD", "status": "success", "user_id": "4217351534" } ], "user_id": "4217351534" } ], "service": null, "shipping_address": { "address1": "8899 Garfield Street, xihuanwann", "address2": "xihuanwann", "city": "Riverside", "company": "", "country": "US", "country_code": "US", "delivery_store_code": null, "delivery_store_name": null, "district": null, "district_code": null, "first_name": "lucous", "last_name": "toba", "latitude": null, "longitude": null, "name": "lucous toba", "phone": "01066666666", "province": "California", "province_code": "4200006", "zip": "92504" }, "shipping_lines": [ { "code": null, "discount_allocations": null, "discounted_price": null, "discounted_price_set": null, "phone": "", "price": "0.00", "price_set": { "presentment_money": { "amount": "0.00", "currency_code": "USD" }, "shop_money": { "amount": "0.00", "currency_code": "USD" } }, "requested_fulfillment_service_id": null, "shipping_price": "0.00", "shipping_price_set": { "presentment_money": { "amount": "0.00", "currency_code": "USD" }, "shop_money": { "amount": "0.00", "currency_code": "USD" } }, "source": null, "tax_lines": [ { "price": "0.00", "price_set": { "presentment_money": { "amount": "0.00", "currency_code": "USD" }, "shop_money": { "amount": "0.00", "currency_code": "USD" } }, "rate": 0, "title": "express_tax" } ], "title": null } ], "source_identifier": null, "source_name": null, "source_url": null, "status": "cancelled", "store_id": "219", "subtotal_price": "1000.0", "subtotal_price_set": { "presentment_money": { "amount": "1000.0", "currency_code": "USD" }, "shop_money": { "amount": "1000.0", "currency_code": "USD" } }, "tags": "[\"Subscription\"]", "tax_lines": [ { "name": "GST", "price": "56.60", "price_set": { "presentment_money": { "amount": "56.60", "currency_code": "USD" }, "shop_money": { "amount": "56.60", "currency_code": "USD" } }, "rate": 0.0566, "title": "product_tax" }, { "name": null, "price": "0.00", "price_set": { "presentment_money": { "amount": "0.00", "currency_code": "USD" }, "shop_money": { "amount": "0.00", "currency_code": "USD" } }, "rate": 0, "title": "express_tax" } ], "tax_number": null, "tax_type": null, "taxes_included": true, "total_discounts": "0.00", "total_discounts_set": { "presentment_money": { "amount": "0.00", "currency_code": "USD" }, "shop_money": { "amount": "0.00", "currency_code": "USD" } }, "total_line_items_price": "1000.00", "total_line_items_price_set": { "presentment_money": { "amount": "1000.00", "currency_code": "USD" }, "shop_money": { "amount": "1000.00", "currency_code": "USD" } }, "total_outstanding": "0.00", "total_shipping_price_set": { "presentment_money": { "amount": "0.00", "currency_code": "USD" }, "shop_money": { "amount": "0.00", "currency_code": "USD" } }, "total_tax": "56.60", "total_tax_set": { "presentment_money": { "amount": "56.60", "currency_code": "USD" }, "shop_money": { "amount": "56.60", "currency_code": "USD" } }, "total_tip_received": "0.00", "total_tip_received_set": { "presentment_money": { "amount": "0.00", "currency_code": "USD" }, "shop_money": { "amount": "0.00", "currency_code": "USD" } }, "total_weight": 0, "updated_at": "2024-11-05T16:28:36+08:00", "user_id": "4217351534", "utm_parameters": null }, { "adjust_price": "0.00", "adjust_price_set": { "presentment_money": { "amount": "0.00", "currency_code": "USD" }, "shop_money": { "amount": "0.00", "currency_code": "USD" } }, "billing_address": { "address1": null, "address2": null, "city": null, "company": null, "country": null, "country_code": null, "first_name": null, "last_name": null, "name": "", "phone": null, "province": null, "province_code": null, "zip": null }, "browser_ip": "183.90.187.195", "buyer_note": null, "cancel_reason": "", "cancelled_at": "2024-11-05T16:47:34+08:00", "cart_token": null, "checkout_id": null, "checkout_token": null, "client_details": { "browser_ip": "183.90.187.195", "session_hash": null, "user_agent": null }, "company": null, "contract_seq": null, "created_at": "2024-11-05T16:42:01+08:00", "credit_limit": null, "currency": "USD", "current_subtotal_price": "1000.00", "current_subtotal_price_set": { "presentment_money": { "amount": "1000.00", "currency_code": "USD" }, "shop_money": { "amount": "1000.00", "currency_code": "USD" } }, "current_total_discounts": "0.00", "current_total_discounts_set": { "presentment_money": { "amount": "0.00", "currency_code": "USD" }, "shop_money": { "amount": "0.00", "currency_code": "USD" } }, "current_total_duties_set": null, "current_total_price": "1000.00", "current_total_price_set": { "presentment_money": { "amount": "1000.00", "currency_code": "USD" }, "shop_money": { "amount": "1000.00", "currency_code": "USD" } }, "current_total_tax": "0.00", "current_total_tax_set": { "presentment_money": { "amount": "0.00", "currency_code": "USD" }, "shop_money": { "amount": "0.00", "currency_code": "USD" } }, "customer": { "addresses": { "address1": null, "address2": null, "city": null, "country": null, "country_code": null, "first_name": null, "last_name": null, "name": "", "phone": null, "province": null, "province_code": null, "zip": null }, "area_code": "86", "created_at": "2021-11-11T15:32:01+08:00", "currency": "USD", "email": null, "first_name": "baiwei xie", "id": "4200115946", "last_name": null, "phone": "18814111769", "updated_at": null }, "customer_locale": null, "deduct_member_point_amount": "0.00", "deduct_member_point_amount_set": { "presentment_money": { "amount": "0.00", "currency_code": "USD" }, "shop_money": { "amount": "0.00", "currency_code": "USD" } }, "discount_applications": [], "discount_codes": [], "email": null, "financial_status": "unpaid", "fulfillment_status": "null", "fulfillments": [], "hidden_order": false, "id": "21067187383398129101990198", "landing_site": null, "line_items": [ { "attribute": null, "country_code_of_origin": null, "customized_attributes": null, "discount_allocations": null, "duties": [], "fulfillable_quantity": 10, "fulfillment_service": null, "fulfillment_status": "null", "gift_card": false, "grams": null, "harmonized_system_code": null, "id": "7456", "image_url": null, "location_id": "5479246478190322184", "name": "Performance Location Split Test Products", "price": "100.00", "price_set": { "presentment_money": { "amount": "100.00", "currency_code": "USD" }, "shop_money": { "amount": "100.00", "currency_code": "USD" } }, "product_id": "16067186511521277740520910", "properties": null, "quantity": 10, "requires_shipping": true, "sku": "11", "tags": "", "tax_lines": [ { "price": "0.00", "price_set": { "presentment_money": { "amount": "0.00", "currency_code": "USD" }, "shop_money": { "amount": "0.00", "currency_code": "USD" } }, "rate": 0, "title": "product_tax", "type": "product_tax" }, { "price": "0.00", "price_set": { "presentment_money": { "amount": "0.00", "currency_code": "USD" }, "shop_money": { "amount": "0.00", "currency_code": "USD" } }, "rate": 0, "title": "express_tax", "type": "shipping_tax" } ], "taxable": false, "title": "Performance Location Split Test Products", "variant_id": "18067186511526478677540910", "variant_title": null, "vendor": null } ], "locations": [ { "address": "12 Stout Street", "address_add": "", "city": "Paterson", "country": "US", "country_code": "US", "district": "", "location_id": "5479245311502721516", "name": "", "phone": "13845678909", "province": "New Jersey", "town": null, "type": "productLocation", "zip": "07522" }, { "address": "600 State Drive", "address_add": "", "city": "Los Angeles", "country": "US", "country_code": "US", "district": "", "location_id": "5479246478190322184", "name": "US - California (600 State Drive, Los Angeles, California 90037, US)", "phone": "13909876789", "province": "California", "town": null, "type": "productLocation", "zip": "90037" } ], "name": "TU202132591", "note": null, "note_attributes": [], "order_at": "2024-11-05T16:42:01+08:00", "order_source": null, "order_status_url": null, "payment_details": [ { "create_time": "2024-11-05T16:42:01+08:00", "gateway": "KOMOJU Other", "pay_amount": 1000, "pay_channel": "KomojuOther", "pay_channel_deal_id": null, "pay_merchant_email": null, "pay_merchant_id": null, "pay_merchant_order_id": null, "pay_seq": "23067187383399303507120198", "pay_status": "unpaid", "processed_at": null, "settle_currency": "USD", "settle_pay_amount": 1000, "status_code": null, "status_msg": null } ], "payment_gateway_names": [ "KomojuOther" ], "payment_terms": null, "phone": "18814111769", "po_number": null, "pos_location_id": null, "presentment_currency": "USD", "processed_at": "2024-11-05T16:42:01+08:00", "processed_user_id": "4200115946", "referring_site": null, "refunds": null, "service": null, "shipping_address": { "address1": null, "address2": null, "city": null, "company": null, "country": null, "country_code": null, "delivery_store_code": null, "delivery_store_name": null, "district": null, "district_code": null, "first_name": null, "last_name": null, "latitude": null, "longitude": null, "name": "", "phone": null, "province": null, "province_code": null, "zip": null }, "shipping_lines": [ { "code": null, "discount_allocations": null, "discounted_price": null, "discounted_price_set": null, "phone": "", "price": "0.00", "price_set": { "presentment_money": { "amount": "0.00", "currency_code": "USD" }, "shop_money": { "amount": "0.00", "currency_code": "USD" } }, "requested_fulfillment_service_id": null, "shipping_price": "0.00", "shipping_price_set": { "presentment_money": { "amount": "0.00", "currency_code": "USD" }, "shop_money": { "amount": "0.00", "currency_code": "USD" } }, "source": null, "tax_lines": [ { "price": "0.00", "price_set": { "presentment_money": { "amount": "0.00", "currency_code": "USD" }, "shop_money": { "amount": "0.00", "currency_code": "USD" } }, "rate": 0, "title": "express_tax" } ], "title": null } ], "source_identifier": null, "source_name": null, "source_url": null, "status": "cancelled", "store_id": "219", "subtotal_price": "1000.0", "subtotal_price_set": { "presentment_money": { "amount": "1000.0", "currency_code": "USD" }, "shop_money": { "amount": "1000.0", "currency_code": "USD" } }, "tags": "[\"Subscription\"]", "tax_lines": [ { "name": null, "price": "0.00", "price_set": { "presentment_money": { "amount": "0.00", "currency_code": "USD" }, "shop_money": { "amount": "0.00", "currency_code": "USD" } }, "rate": 0, "title": "product_tax" }, { "name": null, "price": "0.00", "price_set": { "presentment_money": { "amount": "0.00", "currency_code": "USD" }, "shop_money": { "amount": "0.00", "currency_code": "USD" } }, "rate": 0, "title": "express_tax" } ], "tax_number": null, "tax_type": null, "taxes_included": true, "total_discounts": "0.00", "total_discounts_set": { "presentment_money": { "amount": "0.00", "currency_code": "USD" }, "shop_money": { "amount": "0.00", "currency_code": "USD" } }, "total_line_items_price": "1000.00", "total_line_items_price_set": { "presentment_money": { "amount": "1000.00", "currency_code": "USD" }, "shop_money": { "amount": "1000.00", "currency_code": "USD" } }, "total_outstanding": "1000.00", "total_shipping_price_set": { "presentment_money": { "amount": "0.00", "currency_code": "USD" }, "shop_money": { "amount": "0.00", "currency_code": "USD" } }, "total_tax": "0.00", "total_tax_set": { "presentment_money": { "amount": "0.00", "currency_code": "USD" }, "shop_money": { "amount": "0.00", "currency_code": "USD" } }, "total_tip_received": "0.00", "total_tip_received_set": { "presentment_money": { "amount": "0.00", "currency_code": "USD" }, "shop_money": { "amount": "0.00", "currency_code": "USD" } }, "total_weight": 0, "updated_at": "2024-11-05T16:47:34+08:00", "user_id": "4200115946", "utm_parameters": null } ] } } } } } }, "401": { "headers": { "traceId": { "description": "A globally unique identifier for the request. It is used to track the request flow throughout the system, allowing for easy location and debugging when issues arise." } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "description": "Error message. ", "type": "string" } }, "required": [ "errors" ] } } } }, "429": { "headers": { "traceId": { "description": "A globally unique identifier for the request. It is used to track the request flow throughout the system, allowing for easy location and debugging when issues arise." } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "description": "Error message. ", "type": "string" } }, "required": [ "errors" ] } } } } }, "security": [ { "oauth2": [] } ], "method": "get", "path": "/orders.json", "servers": [ { "url": "https://{handle}.myshopline.com/admin/openapi", "variables": { "handle": { "default": "openapiceshidianpu", "description": "`handle` : The store's unique identifier, which is the prefix of the store's domain name. For example, if a store's domain name is `open001.myshopline.com` , the store handle is `open001` ." } } } ], "info": { "title": "Get orders", "version": "v20270301" }, "authIndexes": [ "read_orders" ] } ```