--- title: "Submit edit results" description: > Order Editing - Submit Interface. Editing an order is a combination of interfaces (start editing, modify product quantity, add regular product lines, add custom product lines, add product line discounts, remove product line discounts, order editing and submission). You need to call the Edit Order - Start interface to start editing once. If there is an error when calling this interface, an error will be obtained in the return value user_ errors field. If the caller calls the Order Editing and Submit interface incorrectly, they need to check whether the current editing has been updated in the returned order data. If the returned order has no value, they need to query the order list query interface to see if the order data has been updated in this editing. If the data is clear but not updated, You can retry (note: retry requires starting from the order_iditjson order editing interface and calling the entire order editing interface again) doc_type: openapi doc_category: openapi doc_version: v20270301 source_url: html: 'https://developer.shopline.com/docs/admin-rest-api/order/edit-order-combination-interface/submit-edit-results' md: 'https://developer.shopline.com/docs/admin-rest-api/order/edit-order-combination-interface/submit-edit-results.md' --- # Submit edit results Order Editing - Submit Interface. Editing an order is a combination of interfaces (start editing, modify product quantity, add regular product lines, add custom product lines, add product line discounts, remove product line discounts, order editing and submission). You need to call the Edit Order - Start interface to start editing once. If there is an error when calling this interface, an error will be obtained in the return value user_ errors field. If the caller calls the Order Editing and Submit interface incorrectly, they need to check whether the current editing has been updated in the returned order data. If the returned order has no value, they need to query the order list query interface to see if the order data has been updated in this editing. If the data is clear but not updated, You can retry (note: retry requires starting from the order_iditjson order editing interface and calling the entire order editing interface again) - **Base URL:** `https://{handle}.myshopline.com/admin/openapi` - **Required Scopes:** `write_orders` - **API Version:** v20270301 - **API Type:** Admin - **API Protocol:** RESTful ## Endpoint ```http POST /orders/order_edit_commit.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 * `write_orders` ## Request ### 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. ### Request Body * `request` object Request body * `notify_customer` boolean Need to inform customers or not * `id` string Edit order draft order id ( can be obtained from call order editing-start interface return parameters ) ## 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 * `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 * `order` object For order information, field descriptions and examples, please refer to the response result of the order list * `id` string Order number , system customization number * `currency` string Transaction currency * `fulfillment_status` string Shipping status, fulfilled-shipped; partial-partially shipped; null-unshipped; Note: the returned enum value is different from the query enumeration value of the input parameter * `email` string Buyer's mailbox, there must be one of the two * `total_tax_set` object Tax summation, multi-currency information * `shop_money` object Sell side amount information * `amount` string Amount, Precision 2 * `currency_code` string Currency * `presentment_money` object Buyer side amount information * `currency_code` string Currency * `amount` string Amount, Precision 2 * `billing_address` object billing address * `zip` string Billing consignee name zip * `city` string Billing consignee city ( up to 64 characters ) * `phone` string Bill consignee name mobile phone number * `last_name` string Bill consignee last name * `province_code` string Billing consignee name province encoding * `name` string Billing name * `address2` string Bill consignee additional to detailed address ( up to 255 characters ) * `country` string Billing consignee country ( up to 64 characters ) * `address1` string Billing consignee detailed address ( up to 255 characters ) * `first_name` string Billing consignee name * `company` string Company name * `country_code` string Billing consignee national encoding * `province` string Billing consignee name province * `current_total_price` string Total tax, product tax + shipping tax * `deduct_member_point_amount` string Current order member point deduction amount * `discount_applications` array Discount information * `value_type` string % discount , amount discount * `allocation_method` string 1 ) across ( the value is distributed in all authorized lines ) 2 ) the ach ( the value is applied to each authorized line ) * `code` string Discount code * `target_type` string 1）line_item、shipping_line * `description` string Description of custom discount * `target_selection` string 1 ) explicit ( discount distribution to clear selection ) 2 ) all ( discount distribution to all lines ) 3 ) ENTITLED ( discount distribution only to the line that its right to use ) * `title` string automatic discount title * `type` string Discount type * `value` string The specific value of the discount ( it can be n-fold , or it can be the specific amount value ) * `total_discounts` string Total discount, marketing discount + artificial discount * `user_id` string Buyer ID * `processed_user_id` string order creator * `total_tip_received` string Tip, precision 2 * `total_weight` double Total product weight ( g ) * `order_status_url` string Order status page URL * `app_id` string App ID * `created_at` string Order creation time (see IOS8601 for the format) * `checkout_id` string Discard id * `tax_number` string TIN * `subtotal_price` string Total product price after discount, total product price - marketing discount - artificial discount * `current_total_discounts_set` object Multi-currency information of the total discount, there is no multi-currency, so the buyer’s and seller’s currency and amount are the same; { currentTotalDiscountsSet "shopMoney": { "amount": "100", "currency_code": "CNY" }, "presentmentMoney": { "amount": "100", "currency_code": "CNY" } } * `presentment_money` object Currency information * `currency_code` string Currency information * `amount` string Amount * `shop_money` object Sell side amount * `amount` string Amount * `currency_code` string Currency * `note_attributes` array Merchant note log, date content * `create_time` string Remark creation time (see IOS8601 for the format) * `name` string Remark source (seller ID) * `value` string Notes * `shipping_address` object Shipping address * `longitude` string Longitude * `country_code` string Country code * `address1` string Address 1 * `last_name` string First name * `name` string Full name * `first_name` string Last name * `province_code` string Province code * `zip` string Postal code * `province` string Province * `address2` string Detailed address 2, optional * `company` string Company name * `latitude` string Latitude * `city` string City * `country` string Country * `phone` string Phone * `credit_limit` object credit payment * `outstanding_credit_limit` string Total credit limit occupied by the order * `total_credit_limit` string Total credit limit used for the order * `credit_limit_currency` string Currency of the credit limit, currently in store currency * `is_credit_limit` boolean Whether the order used credit payment true: Used false: Not used * `financial_status` string Payment status , un pad , authorized , pending , partially_paid , pad , partially_refunded , refunded * `store_id` string store ID * `payment_details` array Payment slip information * `create_time` string Payment slip creation time * `order_seq` string Order number * `pay_seq` string Payment slip number * `status_code` string payment status code * `status_msg` string Payment order status code description * `pay_amount` double Payment amount * `pay_status` string Payment slip status , unpaid- not paid ; pending- paying ; risking- wind control ; paid-paid ; paid_overtime- payment failed ; paid_failed- payment failure ; * `processed_at` string Payment creation time , format : 2023-04-12T22 : 59 : 52+08 : 00 * `pay_channel_deal_id` string External channel payment serial number * `total_shipping_price_set` object Order shipping sum, multi-currency information * `shop_money` object Sell side amount information * `currency_code` string Currency * `amount` string Amount, Precision 2 * `presentment_money` object Buyer side amount information * `amount` string Amount, Precision 2 * `currency_code` string Currency * `updated_at` string Order update time, (see IOS8601 for the format) * `current_subtotal_price_set` object Multi-currency information of the current commodity sum, the buyer's and seller's currency and the amount are the same * `presentment_money` object Buy side currency * `amount` string Amount * `currency_code` string Currency * `shop_money` object Sell side amount * `amount` string Amount, Precision 2 * `currency_code` string Currency code * `subtotal_price_set` object Multi-currency information of total product price after discount * `presentment_money` object Buyer side amount information * `amount` string Amount, Precision 2 * `currency_code` string Currency * `shop_money` object Sell side amount information * `amount` string Amount, Precision 2 * `currency_code` string Currency * `total_line_items_price_set` object Sum of original price of goods, multi-currency information * `shop_money` object Sell side amount information * `amount` string Amount, Precision 2 * `currency_code` string Currency * `presentment_money` object Buyer side amount information * `amount` string Amount, Precision 2 * `currency_code` string Currency * `discount_codes` array Promo code information * `code` string Promo code * `type` string Type of discount, reduced amount; discount; free shipping; fixed price; the lowest price item is free; package price; the Nth item is discounted; * `amount` string Discount amount, precision 2 * `shipping_lines` array Logistics information * `price` string Logistics freight, precision 2 * `price_set` object Logistics freight multi-resource information * `shop_money` object Amount information on the store side * `presentment_money` object Buyer side amount information * `discount_allocations` array Discount Details * `amount` string Discount amount, precision 2 * `amount_set` object Discount Multi-Currency Amount * `discount_application_index` integer Discount index information : marked in the position of the discount details * `requested_fulfillment_service_id` string Transportation service code * `code` string Logistics number * `source` string Shipping source * `discounted_price` string Discount amount, precision 2 * `phone` string Phone * `tax_lines` array Logistics tax list * `title` string Tax name * `price` string tax * `price_set` object Multi-currency information of tax * `rate` double Tax rate * `title` string Logistics name * `discounted_price_set` object Discount Multi-Currency Amount * `presentment_money` object Buyer side amount information * `shop_money` object Amount information on the store side * `shipping_price` string The value of the original shipping fee (not the amount after the discount) * `current_total_price_set` object Multi-currency information of the sum of taxes, the currency and amount of buyers and sellers are the same * `shop_money` object Sell side currency * `currency_code` string Currency * `amount` string Amount * `presentment_money` object Buy side currency * `amount` string Amount * `currency_code` string Currency * `payment_gateway_names` array List of payment methods, list of payment methods used for this order, SLpayments, Paypal (PayPal payment), Oceanpay (Oceanpayment), TwoCheckout, AsiaBill, Stripe, Pacypay, WorldPay, COD (cash on delivery), CUSTOM (custom), adjustPay (funding adjustment), Xendit (xendit credit card), XenditOther * `total_discounts_set` object Multi-currency information of discount total * `presentment_money` object Buyer side amount information * `currency_code` string Currency * `amount` string Amount, Precision 2 * `shop_money` object Sell side amount information * `currency_code` string Currency * `amount` string Amount, Precision 2 * `cancel_reason` string Seller's reason for cancellation * `current_total_tax_set` object Multi-currency information of the sum of taxes, the currency and amount of buyers and sellers are the same * `presentment_money` object Buy side currency * `amount` string Amount * `currency_code` string Currency * `shop_money` object Sell side currency * `amount` string Amount * `currency_code` string Currency * `processed_at` string Processed_at time , format : 2023-04-12T22 : 59 : 52+08 : 00 * `total_line_items_price` string Sum of original prices of goods, precision 2 * `tags` string order label * `checkout_token` string Settlement page token * `current_total_discounts` string Sum of discounts, precision 2, marketing offers + artificial discounts * `note` string Merchant notes * `refunds` array Refund list * `created_at` string Refund form creation time (see IOS8601 for the format) * `id` string Refund ID * `note` string Refund Notes * `order_id` string Order number * `processed_at` string Update time (see IOS8601 for the format) * `refund_line_items` array Refund Details * `line_item_id` string The ID of the product snapshot table, generated by the system, uniquely confirms a product with the order number * `total_tax_set` object Total tax amount, multi-currency information * `subtotal_set` object Total refund amount, multi-currency information, same on seller and buyer side * `total_tax` double Tax amount of refunded goods, precision 2 * `line_item` object Refund Product line * `quantity` integer Quantity, quantity of goods * `restock_type` string Inventory return type, no_restock-not returned, cancel-cancelled, return-returned only not returned * `id` string Order number for this adjustment of the single link * `subtotal` double Total refund amount, precision 2 * `transactions` array Refund transaction information * `status` string Handling status, pending, failure, success, and error * `currency` string Currency * `order_id` string Order number * `user_id` string Buyer ID * `amount` string Refund amount , accuracy 2 * `created_at` string Creation time * `id` string Refund ID * `processed_at` string Refund order update time ( format see IOS8601 ) * `kind` string Transaction type (authorization, capture, sale, void, refund) * `user_id` string User ID * `current_subtotal_price` string Sum of current products, total price of products * quantity * `line_items` array Order product snapshot information * `discount_allocations` array Marketing discount detail amount multi-currency * `amount` string Discount detail amount * `amount_set` object Discount Details Amount Multi-Currency * `discount_application_index` integer Indicate the location in the discount details * `title` string Product title * `name` string SKU title, same as title * `variant_id` string Product SKU serial number * `product_id` string SPU serial number * `attribute` string Product attributes : name-attribute value multiple comma " , " division like : color-red , size-x * `location_id` string The location corresponding to the store in the pos scene * `fulfillment_status` string The shipping status of the product, shipping status, fulfilled-shipped; partial-partially shipped; null-unshipped; * `id` string The ID of the product snapshot table, generated by the system, uniquely confirms a product with the order number * `vendor` string Supplier * `tax_lines` array Tax information * `price_set` object Multi-currency information of tax * `rate` double Tax rate * `title` string Tax name * `type` string Tax fee type, used to distinguish whether it is commodity tax or freight tax, the enumerated values ​​are as follows product_tax: commodity tax shipping_tax: freight tax * `price` string Tax, precision 2 * `quantity` integer Quantity of items in the order * `grams` double Weight ( grams ) * `requires_shipping` boolean Shipping or not * `variant_title` string Commodity attribute value, multiple divided by " / ", such as: "155 / red / large" * `sku` string Product code, barCode * `price` string Commodity price, precision 2 * `taxable` boolean Tax or not？ * `fulfillment_service` string Logistics company name * `properties` array Product customization information * `additional` string Additional Fields for Custom Items * `name` string Custom attribute name * `type` string Attribute type, text-character, the display format is name: value; picture-picture, the display type is name: get the rendered thumbnail through URLs; link-hyperlink, the display type is name: value, supports clicking on the link to jump to urls First * `urls` array URL resource list * `value` string Custom attribute values * `tags` string Commodity tags (separated by multiple commas) * `fulfillable_quantity` integer Available quantity * `current_total_tax` string Total tax, product tax + shipping tax * `presentment_currency` string Buy side currency, same as sell side currency * `total_tax` string Sum of taxes, precision 2, commodity tax + shipping tax * `name` string Custom order number * `cart_token` string Shopping cart token * `customer_locale` string Buyer country, language code + country name abbreviation * `taxes_included` boolean Does the total include tax? * `customer` object Buyer information * `first_name` string First name * `id` string User ID * `created_at` string Buyer creation time (see IOS8601 for the format) * `currency` string Currency * `phone` string User mobile phone number * `updated_at` string Buyer update time * `area_code` string Phone area code * `addresses` object Buyer address information * `address2` string Detailed address 2, optional * `first_name` string Last name * `address1` string Detailed address 1 * `phone` string Phone * `province` string Province * `city` string City * `name` string Full name * `country_code` string Country code * `province_code` string Province code * `zip` string Postal code * `country` string Country * `last_name` string First name * `email` string User mailbox * `last_name` string Last name * `cancelled_at` string Order cancellation time (end) (see IOS8601 for the format), 2012-05-01T14:22:25-04:00 * `tax_lines` array Tax information * `price_set` object Multi-currency information of tax * `presentment_money` object Buyer side amount information * `shop_money` object Sell side amount information * `rate` double Tax rate * `title` string Tax name * `price` string Tax amount * `tax_type` string Types of tax ID * `client_details` object Client Details * `browser_ip` string Client ip address * `session_hash` string Member session encryption information * `user_agent` string Client Proxy * `fulfillments` array Package information * `id` string Package number * `tracking_company` string Logistics company name * `tracking_url` string Logistics company URL * `updated_at` string Update time (see IOS8601 for the format) * `shipment_status` string Package tracking * `status` string Logistics delivery status, success-shipped; cancelled-cancelled; * `created_at` string Creation time (see IOS8601 for the format) * `line_items` array Product list * `product_id` string SPU serial number * `quantity` integer Quantity of items in the order * `requires_shipping` boolean Shipping or not * `variant_id` string Product SKU serial number * `sku` string Product code, barCode * `id` string The ID of the product snapshot table, generated by the system, uniquely confirms a product with the order number * `name` string SKU title, same as title * `vendor` string Supplier * `variant_title` string Commodity attribute value, multiple divided by " / ", such as: "155 / red / large" * `taxable` boolean Tax or not？ * `fulfillable_quantity` integer Available quantity * `fulfillment_status` string The shipping status of the product, shipping status, fulfilled-shipped; partial-partially shipped; null-unshipped; * `title` string Product title * `fulfillment_service` string Logistics company name * `price` string Commodity price, precision 2 * `tax_lines` array Tax information * `grams` double Weight ( grams ) * `attribute` string Product attributes : name-attribute value multiple comma " , " division like : color-red , size-x * `tracking_number` string Third party tracking number * `name` string invoice short number * `order_id` string Order number * `total_outstanding` string Sum of unpaid amount, precision 2 * `phone` string Buyer contact information, there must be one of the two * `browser_ip` string Client IP * `user_errors` array Error prompt information in this execution , if the implementation result is wrong , this field will return error information * `code` string Wrong code * `field` array Path that causes incorrect input fields * `message` string Error message #### 401 * `errors` string Error message. #### 429 * `errors` string Error message. ## OpenAPI Definition ```json { "description": "Order Editing - Submit Interface. Editing an order is a combination of interfaces (start editing, modify product quantity, add regular product lines, add custom product lines, add product line discounts, remove product line discounts, order editing and submission). You need to call the Edit Order - Start interface to start editing once. If there is an error when calling this interface, an error will be obtained in the return value user_ errors field. If the caller calls the Order Editing and Submit interface incorrectly, they need to check whether the current editing has been updated in the returned order data. If the returned order has no value, they need to query the order list query interface to see if the order data has been updated in this editing. If the data is clear but not updated, You can retry (note: retry requires starting from the order_iditjson order editing interface and calling the entire order editing interface again)", "externalDocs": { "description": "Permission point used by the interface is `write_orders` , For more information about the use of permission points, see", "url": "ec20/3cv5d7wpfgr6a8z5/xabczf5442284vkq?lang=en", "errorTableDescription": "" }, "operationId": "VYvYsoxh", "parameters": [ { "name": "Content-Type", "in": "header", "description": "The field must be set to the fixed value `application/json; charset=utf-8`.", "required": true, "style": "string", "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. Please 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 put the obtained access token into the API request header in Bearer Token.", "type": "string", "example": "Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA" }, "example": "Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "request": { "name": "request", "description": "Request body", "type": "object", "properties": { "notify_customer": { "name": "notify_customer", "description": "Need to inform customers or not", "type": "boolean", "example": false }, "id": { "name": "id", "description": "Edit order draft order id ( can be obtained from call order editing-start interface return parameters )", "type": "string", "example": "2108973455469898" } }, "required": [ "id" ], "example": { "id": "2108973455469898", "notify_customer": false } } }, "example": { "request": { "id": "2108973455469898", "notify_customer": false } } } } }, "required": true }, "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": { "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": { "order": { "name": "order", "description": "For order information, field descriptions and examples, please refer to the response result of the order list", "type": "object", "properties": { "id": { "name": "id", "description": "Order number , system customization number", "type": "string", "example": "21050224312121887324667162" }, "currency": { "name": "currency", "description": "Transaction currency", "type": "string", "example": "USD" }, "fulfillment_status": { "name": "fulfillment_status", "description": "Shipping status, fulfilled-shipped; partial-partially shipped; null-unshipped; Note: the returned enum value is different from the query enumeration value of the input parameter", "type": "string", "example": "fulfilled" }, "email": { "name": "email", "description": "Buyer's mailbox, there must be one of the two", "type": "string", "example": "test1002@Gmail.com" }, "total_tax_set": { "name": "total_tax_set", "description": "Tax summation, multi-currency information", "type": "object", "properties": { "shop_money": { "name": "shop_money", "description": "Sell side amount information", "type": "object", "properties": { "amount": { "name": "amount", "description": "Amount, Precision 2", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "Currency", "type": "string", "example": "USD" } }, "example": { "amount": "8.00", "currency_code": "USD" } }, "presentment_money": { "name": "presentment_money", "description": "Buyer side amount information", "type": "object", "properties": { "currency_code": { "name": "currency_code", "description": "Currency", "type": "string", "example": "USD" }, "amount": { "name": "amount", "description": "Amount, Precision 2", "type": "string", "example": "8.00" } }, "example": { "currency_code": "USD", "amount": "8.00" } } }, "example": { "shop_money": { "amount": "8.00", "currency_code": "USD" }, "presentment_money": { "amount": "8.00", "currency_code": "USD" } } }, "billing_address": { "name": "billing_address", "description": "billing address", "type": "object", "properties": { "zip": { "name": "zip", "description": "Billing consignee name zip", "type": "string", "example": "521000" }, "city": { "name": "city", "description": "Billing consignee city ( up to 64 characters )", "type": "string", "example": "New York" }, "phone": { "name": "phone", "description": "Bill consignee name mobile phone number", "type": "string", "example": "13890312312" }, "last_name": { "name": "last_name", "description": "Bill consignee last name", "type": "string", "example": "Washington" }, "province_code": { "name": "province_code", "description": "Billing consignee name province encoding", "type": "string", "example": "4300006" }, "name": { "name": "name", "description": "Billing name", "type": "string", "example": "Tom Washington" }, "address2": { "name": "address2", "description": "Bill consignee additional to detailed address ( up to 255 characters )", "type": "string", "example": "Address 2" }, "country": { "name": "country", "description": "Billing consignee country ( up to 64 characters )", "type": "string", "example": "Usa" }, "address1": { "name": "address1", "description": "Billing consignee detailed address ( up to 255 characters )", "type": "string", "example": "Address 1" }, "first_name": { "name": "first_name", "description": "Billing consignee name", "type": "string", "example": "Tom" }, "company": { "name": "company", "description": "Company name", "type": "string", "example": "new company" }, "country_code": { "name": "country_code", "description": "Billing consignee national encoding", "type": "string", "example": "US" }, "province": { "name": "province", "description": "Billing consignee name province", "type": "string", "example": "California" } }, "example": { "city": "New York", "last_name": "Washington", "phone": "13890312312", "province_code": "4300006", "address2": "Address 2", "province": "California", "country_code": "US", "zip": "521000", "country": "Usa", "first_name": "Tom", "company": "new company", "name": "Tom Washington", "address1": "Address 1" } }, "current_total_price": { "name": "current_total_price", "description": "Total tax, product tax + shipping tax", "type": "string", "example": "8.00" }, "deduct_member_point_amount": { "name": "deduct_member_point_amount", "description": "Current order member point deduction amount", "type": "string", "example": "3.25" }, "discount_applications": { "name": "discount_applications", "description": "Discount information", "type": "array", "items": { "name": "discount_applications", "description": "Discount information", "type": "object", "properties": { "value_type": { "name": "value_type", "description": "% discount , amount discount", "type": "string", "example": "fixed_amount" }, "allocation_method": { "name": "allocation_method", "description": "1 ) across ( the value is distributed in all authorized lines ) 2 ) the ach ( the value is applied to each authorized line )", "type": "string", "example": "across" }, "code": { "name": "code", "description": "Discount code", "type": "string", "example": "1Q3UMQM8RBP5" }, "target_type": { "name": "target_type", "description": "1）line_item、shipping_line", "type": "string", "example": "line_item" }, "description": { "name": "description", "description": "Description of custom discount", "type": "string", "example": "Discount description" }, "target_selection": { "name": "target_selection", "description": "1 ) explicit ( discount distribution to clear selection ) 2 ) all ( discount distribution to all lines ) 3 ) ENTITLED ( discount distribution only to the line that its right to use )", "type": "string", "example": "explicit" }, "title": { "name": "title", "description": "automatic discount title", "type": "string", "example": "Discount title" }, "type": { "name": "type", "description": "Discount type", "type": "string", "example": "manual" }, "value": { "name": "value", "description": "The specific value of the discount ( it can be n-fold , or it can be the specific amount value )", "type": "string", "example": "20" } }, "example": { "description": "Discount description", "value": "20", "value_type": "fixed_amount", "target_type": "line_item", "allocation_method": "across", "type": "manual", "code": "1Q3UMQM8RBP5", "title": "Discount title", "target_selection": "explicit" } }, "example": [ { "target_type": "line_item", "value_type": "fixed_amount", "title": "Discount title", "target_selection": "explicit", "code": "1Q3UMQM8RBP5", "type": "manual", "value": "20", "description": "Discount description", "allocation_method": "across" } ] }, "total_discounts": { "name": "total_discounts", "description": "Total discount, marketing discount + artificial discount", "type": "string", "example": "3.25" }, "user_id": { "name": "user_id", "description": "Buyer ID", "type": "string", "example": "4201057495" }, "processed_user_id": { "name": "processed_user_id", "description": "order creator", "type": "string", "example": "4201057495" }, "total_tip_received": { "name": "total_tip_received", "description": "Tip, precision 2", "type": "string", "example": "8.00" }, "total_weight": { "name": "total_weight", "description": "Total product weight ( g )", "type": "double", "example": 100 }, "order_status_url": { "name": "order_status_url", "description": "Order status page URL", "type": "string", "example": "https://shoptest.myshoplinestg.com/trade/thank_you?mainOrderMark=xxx&mainOrderSeq=200565776406008509" }, "app_id": { "name": "app_id", "description": "App ID", "type": "string", "example": "222222" }, "created_at": { "name": "created_at", "description": "Order creation time (see IOS8601 for the format)", "type": "string", "example": "2012-05-01T14:22:25-04:00" }, "checkout_id": { "name": "checkout_id", "description": "Discard id", "type": "string", "example": "2404785166526352972864" }, "tax_number": { "name": "tax_number", "description": "TIN", "type": "string", "example": "111111" }, "subtotal_price": { "name": "subtotal_price", "description": "Total product price after discount, total product price - marketing discount - artificial discount", "type": "string", "example": "3.25" }, "current_total_discounts_set": { "name": "current_total_discounts_set", "description": "Multi-currency information of the total discount, there is no multi-currency, so the buyer’s and seller’s currency and amount are the same; { currentTotalDiscountsSet \"shopMoney\": { \"amount\": \"100\", \"currency_code\": \"CNY\" }, \"presentmentMoney\": { \"amount\": \"100\", \"currency_code\": \"CNY\" } }", "type": "object", "properties": { "presentment_money": { "name": "presentment_money", "description": "Currency information", "type": "object", "properties": { "currency_code": { "name": "currency_code", "description": "Currency information", "type": "string", "example": "USD" }, "amount": { "name": "amount", "description": "Amount", "type": "string", "example": "3.25" } }, "example": { "amount": "3.25", "currency_code": "USD" } }, "shop_money": { "name": "shop_money", "description": "Sell side amount", "type": "object", "properties": { "amount": { "name": "amount", "description": "Amount", "type": "string", "example": "3.25" }, "currency_code": { "name": "currency_code", "description": "Currency", "type": "string", "example": "USD" } }, "example": { "amount": "3.25", "currency_code": "USD" } } }, "example": { "presentment_money": { "amount": "3.25", "currency_code": "USD" }, "shop_money": { "currency_code": "USD", "amount": "3.25" } } }, "note_attributes": { "name": "note_attributes", "description": "Merchant note log, date content", "type": "array", "items": { "name": "note_attributes", "description": "Merchant note log, date content", "type": "object", "properties": { "create_time": { "name": "create_time", "description": "Remark creation time (see IOS8601 for the format)", "type": "string", "example": "2012-05-01T14:22:25-04:00" }, "name": { "name": "name", "description": "Remark source (seller ID)", "type": "string", "example": "Notes source" }, "value": { "name": "value", "description": "Notes", "type": "string", "example": "Notes" } }, "example": { "value": "Notes", "create_time": "2012-05-01T14:22:25-04:00", "name": "Notes source" } }, "example": [ { "create_time": "2012-05-01T14:22:25-04:00", "name": "Notes source", "value": "Notes" } ] }, "shipping_address": { "name": "shipping_address", "description": "Shipping address", "type": "object", "properties": { "longitude": { "name": "longitude", "description": "Longitude", "type": "string", "example": "41" }, "country_code": { "name": "country_code", "description": "Country code", "type": "string", "example": "US" }, "address1": { "name": "address1", "description": "Address 1", "type": "string", "example": "Address 1" }, "last_name": { "name": "last_name", "description": "First name", "type": "string", "example": "Washington" }, "name": { "name": "name", "description": "Full name", "type": "string", "example": "Tom Washington" }, "first_name": { "name": "first_name", "description": "Last name", "type": "string", "example": "Tom" }, "province_code": { "name": "province_code", "description": "Province code", "type": "string", "example": "4200006" }, "zip": { "name": "zip", "description": "Postal code", "type": "string", "example": "92503" }, "province": { "name": "province", "description": "Province", "type": "string", "example": "California" }, "address2": { "name": "address2", "description": "Detailed address 2, optional", "type": "string", "example": "Address 2" }, "company": { "name": "company", "description": "Company name", "type": "string", "example": "New company name" }, "latitude": { "name": "latitude", "description": "Latitude", "type": "string", "example": "15" }, "city": { "name": "city", "description": "City", "type": "string", "example": "New York" }, "country": { "name": "country", "description": "Country", "type": "string", "example": "Usa" }, "phone": { "name": "phone", "description": "Phone", "type": "string", "example": "1320987655" } }, "example": { "address2": "Address 2", "province_code": "4200006", "zip": "92503", "last_name": "Washington", "country": "Usa", "address1": "Address 1", "phone": "1320987655", "longitude": "41", "first_name": "Tom", "latitude": "15", "country_code": "US", "company": "New company name", "name": "Tom Washington", "city": "New York", "province": "California" } }, "credit_limit": { "name": "credit_limit", "description": "credit payment", "type": "object", "properties": { "outstanding_credit_limit": { "name": "outstanding_credit_limit", "description": "Total credit limit occupied by the order", "type": "string", "example": "1.00" }, "total_credit_limit": { "name": "total_credit_limit", "description": "Total credit limit used for the order", "type": "string", "example": "1.00" }, "credit_limit_currency": { "name": "credit_limit_currency", "description": "Currency of the credit limit, currently in store currency", "type": "string", "example": "USD" }, "is_credit_limit": { "name": "is_credit_limit", "description": "Whether the order used credit payment\ntrue: Used\nfalse: Not used", "type": "boolean", "example": true } }, "example": { "credit_limit_currency": "USD", "is_credit_limit": true, "outstanding_credit_limit": "1.00", "total_credit_limit": "1.00" } }, "financial_status": { "name": "financial_status", "description": "Payment status , un pad , authorized , pending , partially_paid , pad , partially_refunded , refunded", "type": "string", "example": "unpaid" }, "store_id": { "name": "store_id", "description": "store ID", "type": "string", "example": "1644828244663" }, "payment_details": { "name": "payment_details", "description": "Payment slip information", "type": "array", "items": { "name": "payment_details", "description": "Payment slip information", "type": "object", "properties": { "create_time": { "name": "create_time", "description": "Payment slip creation time", "type": "string", "example": "2012-05-01T14:22:25-04:00" }, "order_seq": { "name": "order_seq", "description": "Order number", "type": "string", "example": "23057287797738260472676128" }, "pay_seq": { "name": "pay_seq", "description": "Payment slip number", "type": "string", "example": "23057287797738260472676128" }, "status_code": { "name": "status_code", "description": "payment status code", "type": "string", "example": "RISK_PENDING" }, "status_msg": { "name": "status_msg", "description": "Payment order status code description", "type": "string", "example": "PENDING_REVIEW" }, "pay_amount": { "name": "pay_amount", "description": "Payment amount", "type": "double", "example": 3.25 }, "pay_status": { "name": "pay_status", "description": "Payment slip status , unpaid- not paid ; pending- paying ; risking- wind control ; paid-paid ; paid_overtime- payment failed ; paid_failed- payment failure ;", "type": "string", "example": "unpaid" }, "processed_at": { "name": "processed_at", "description": "Payment creation time , format : 2023-04-12T22 : 59 : 52+08 : 00", "type": "string", "example": "2023-04-12T22:59:52+08:00" }, "pay_channel_deal_id": { "name": "pay_channel_deal_id", "description": "External channel payment serial number", "type": "string", "example": "pi_3MI897Hezv8FxjBO1uGxMPhX" } }, "example": { "pay_seq": "23057287797738260472676128", "create_time": "2012-05-01T14:22:25-04:00", "processed_at": "2023-04-12T22:59:52+08:00", "status_msg": "PENDING_REVIEW", "pay_amount": 3.25, "status_code": "RISK_PENDING", "pay_status": "unpaid", "pay_channel_deal_id": "pi_3MI897Hezv8FxjBO1uGxMPhX", "order_seq": "23057287797738260472676128" } }, "example": [ { "order_seq": "23057287797738260472676128", "pay_amount": 3.25, "create_time": "2012-05-01T14:22:25-04:00", "status_msg": "PENDING_REVIEW", "pay_channel_deal_id": "pi_3MI897Hezv8FxjBO1uGxMPhX", "pay_seq": "23057287797738260472676128", "pay_status": "unpaid", "processed_at": "2023-04-12T22:59:52+08:00", "status_code": "RISK_PENDING" } ] }, "total_shipping_price_set": { "name": "total_shipping_price_set", "description": "Order shipping sum, multi-currency information", "type": "object", "properties": { "shop_money": { "name": "shop_money", "description": "Sell side amount information", "type": "object", "properties": { "currency_code": { "name": "currency_code", "description": "Currency", "type": "string", "example": "USD" }, "amount": { "name": "amount", "description": "Amount, Precision 2", "type": "string", "example": "8.00" } }, "example": { "amount": "8.00", "currency_code": "USD" } }, "presentment_money": { "name": "presentment_money", "description": "Buyer side amount information", "type": "object", "properties": { "amount": { "name": "amount", "description": "Amount, Precision 2", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "Currency", "type": "string", "example": "USD" } }, "example": { "amount": "8.00", "currency_code": "USD" } } }, "example": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "currency_code": "USD", "amount": "8.00" } } }, "updated_at": { "name": "updated_at", "description": "Order update time, (see IOS8601 for the format)", "type": "string", "example": "2012-05-01T14:22:25-04:00" }, "current_subtotal_price_set": { "name": "current_subtotal_price_set", "description": "Multi-currency information of the current commodity sum, the buyer's and seller's currency and the amount are the same", "type": "object", "properties": { "presentment_money": { "name": "presentment_money", "description": "Buy side currency", "type": "object", "properties": { "amount": { "name": "amount", "description": "Amount", "type": "string", "example": "78.08" }, "currency_code": { "name": "currency_code", "description": "Currency", "type": "string", "example": "USD" } }, "example": { "amount": "78.08", "currency_code": "USD" } }, "shop_money": { "name": "shop_money", "description": "Sell side amount", "type": "object", "properties": { "amount": { "name": "amount", "description": "Amount, Precision 2", "type": "string", "example": "78.08" }, "currency_code": { "name": "currency_code", "description": "Currency code", "type": "string", "example": "USD" } }, "example": { "currency_code": "USD", "amount": "78.08" } } }, "example": { "shop_money": { "currency_code": "USD", "amount": "78.08" }, "presentment_money": { "currency_code": "USD", "amount": "78.08" } } }, "subtotal_price_set": { "name": "subtotal_price_set", "description": "Multi-currency information of total product price after discount", "type": "object", "properties": { "presentment_money": { "name": "presentment_money", "description": "Buyer side amount information", "type": "object", "properties": { "amount": { "name": "amount", "description": "Amount, Precision 2", "type": "string", "example": "3.25" }, "currency_code": { "name": "currency_code", "description": "Currency", "type": "string", "example": "USD" } }, "example": { "amount": "3.25", "currency_code": "USD" } }, "shop_money": { "name": "shop_money", "description": "Sell side amount information", "type": "object", "properties": { "amount": { "name": "amount", "description": "Amount, Precision 2", "type": "string", "example": "3.25" }, "currency_code": { "name": "currency_code", "description": "Currency", "type": "string", "example": "USD" } }, "example": { "amount": "3.25", "currency_code": "USD" } } }, "example": { "shop_money": { "amount": "3.25", "currency_code": "USD" }, "presentment_money": { "currency_code": "USD", "amount": "3.25" } } }, "total_line_items_price_set": { "name": "total_line_items_price_set", "description": "Sum of original price of goods, multi-currency information", "type": "object", "properties": { "shop_money": { "name": "shop_money", "description": "Sell side amount information", "type": "object", "properties": { "amount": { "name": "amount", "description": "Amount, Precision 2", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "Currency", "type": "string", "example": "USD" } }, "example": { "amount": "8.00", "currency_code": "USD" } }, "presentment_money": { "name": "presentment_money", "description": "Buyer side amount information", "type": "object", "properties": { "amount": { "name": "amount", "description": "Amount, Precision 2", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "Currency", "type": "string", "example": "USD" } }, "example": { "amount": "8.00", "currency_code": "USD" } } }, "example": { "shop_money": { "amount": "8.00", "currency_code": "USD" }, "presentment_money": { "amount": "8.00", "currency_code": "USD" } } }, "discount_codes": { "name": "discount_codes", "description": "Promo code information", "type": "array", "items": { "name": "discount_codes", "description": "Promo code information", "type": "object", "properties": { "code": { "name": "code", "description": "Promo code", "type": "string", "example": "KIN4GNAB2FRH" }, "type": { "name": "type", "description": "Type of discount, reduced amount; discount; free shipping; fixed price; the lowest price item is free; package price; the Nth item is discounted;", "type": "string", "example": "deduction amount" }, "amount": { "name": "amount", "description": "Discount amount, precision 2", "type": "string", "example": "3.25" } }, "example": { "amount": "3.25", "code": "KIN4GNAB2FRH", "type": "deduction amount" } }, "example": [ { "amount": "3.25", "code": "KIN4GNAB2FRH", "type": "deduction amount" } ] }, "shipping_lines": { "name": "shipping_lines", "description": "Logistics information", "type": "array", "items": { "name": "shipping_lines", "description": "Logistics information", "type": "object", "properties": { "price": { "name": "price", "description": "Logistics freight, precision 2", "type": "string", "example": "8.00" }, "price_set": { "name": "price_set", "description": "Logistics freight multi-resource information", "type": "object", "properties": { "shop_money": { "name": "shop_money", "description": "Amount information on the store side", "type": "object", "properties": { "amount": { "name": "amount", "description": "Amount, Precision 2", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "Currency", "type": "string", "example": "USD" } }, "example": { "currency_code": "USD", "amount": "8.00" } }, "presentment_money": { "name": "presentment_money", "description": "Buyer side amount information", "type": "object", "properties": { "amount": { "name": "amount", "description": "Amount, Precision 2", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "Currency", "type": "string", "example": "USD" } }, "example": { "amount": "8.00", "currency_code": "USD" } } }, "example": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "currency_code": "USD", "amount": "8.00" } } }, "discount_allocations": { "name": "discount_allocations", "description": "Discount Details", "type": "array", "items": { "name": "discount_allocations", "description": "Discount Details", "type": "object", "properties": { "amount": { "name": "amount", "description": "Discount amount, precision 2", "type": "string", "example": "8.00" }, "amount_set": { "name": "amount_set", "description": "Discount Multi-Currency Amount", "type": "object", "properties": { "shop_money": { "name": "shop_money", "description": "Amount information on the store side", "type": "object", "properties": { "amount": { "name": "amount", "description": "Amount, Precision 2", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "Currency", "type": "string", "example": "USD" } }, "example": { "amount": "8.00", "currency_code": "USD" } }, "presentment_money": { "name": "presentment_money", "description": "Buyer side amount information", "type": "object", "properties": { "amount": { "name": "amount", "description": "Amount, Precision 2", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "Currency", "type": "string", "example": "USD" } }, "example": { "currency_code": "USD", "amount": "8.00" } } }, "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": "Discount index information : marked in the position of the discount details", "type": "integer", "example": 1 } }, "example": { "amount": "8.00", "amount_set": { "presentment_money": { "currency_code": "USD", "amount": "8.00" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } }, "discount_application_index": 1 } }, "example": [ { "amount": "8.00", "amount_set": { "shop_money": { "amount": "8.00", "currency_code": "USD" }, "presentment_money": { "amount": "8.00", "currency_code": "USD" } }, "discount_application_index": 1 } ] }, "requested_fulfillment_service_id": { "name": "requested_fulfillment_service_id", "description": "Transportation service code", "type": "string", "example": "LX88888" }, "code": { "name": "code", "description": "Logistics number", "type": "string", "example": "SF" }, "source": { "name": "source", "description": "Shipping source", "type": "string", "example": "source" }, "discounted_price": { "name": "discounted_price", "description": "Discount amount, precision 2", "type": "string", "example": "8.00" }, "phone": { "name": "phone", "description": "Phone", "type": "string", "example": "13243214565" }, "tax_lines": { "name": "tax_lines", "description": "Logistics tax list", "type": "array", "items": { "name": "tax_lines", "description": "Logistics tax list", "type": "object", "properties": { "title": { "name": "title", "description": "Tax name", "type": "string", "example": "tax" }, "price": { "name": "price", "description": "tax", "type": "string", "example": "8.00" }, "price_set": { "name": "price_set", "description": "Multi-currency information of tax", "type": "object", "properties": { "presentment_money": { "name": "presentment_money", "description": "Buyer side amount information", "type": "object", "properties": { "amount": { "name": "amount", "description": "Amount", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "Currency", "type": "string", "example": "USD" } }, "example": { "amount": "8.00", "currency_code": "USD" } }, "shop_money": { "name": "shop_money", "description": "Sell side amount information", "type": "object", "properties": { "amount": { "name": "amount", "description": "Amount, Precision 2", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "Currency", "type": "string", "example": "USD" } }, "example": { "amount": "8.00", "currency_code": "USD" } } }, "example": { "shop_money": { "amount": "8.00", "currency_code": "USD" }, "presentment_money": { "amount": "8.00", "currency_code": "USD" } } }, "rate": { "name": "rate", "description": "Tax rate", "type": "double", "example": 1 } }, "example": { "price_set": { "shop_money": { "amount": "8.00", "currency_code": "USD" }, "presentment_money": { "currency_code": "USD", "amount": "8.00" } }, "rate": 1, "title": "tax", "price": "8.00" } }, "example": [ { "price": "8.00", "price_set": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "currency_code": "USD", "amount": "8.00" } }, "rate": 1, "title": "tax" } ] }, "title": { "name": "title", "description": "Logistics name", "type": "string", "example": "SF International" }, "discounted_price_set": { "name": "discounted_price_set", "description": "Discount Multi-Currency Amount", "type": "object", "properties": { "presentment_money": { "name": "presentment_money", "description": "Buyer side amount information", "type": "object", "properties": { "currency_code": { "name": "currency_code", "description": "Currency", "type": "string", "example": "USD" }, "amount": { "name": "amount", "description": "Amount, Precision 2", "type": "string", "example": "8.00" } }, "example": { "amount": "8.00", "currency_code": "USD" } }, "shop_money": { "name": "shop_money", "description": "Amount information on the store side", "type": "object", "properties": { "amount": { "name": "amount", "description": "Amount, Precision 2", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "Currency", "type": "string", "example": "USD" } }, "example": { "currency_code": "USD", "amount": "8.00" } } }, "example": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } } }, "shipping_price": { "name": "shipping_price", "description": "The value of the original shipping fee (not the amount after the discount)", "type": "string", "example": "8.00" } }, "example": { "price_set": { "shop_money": { "amount": "8.00", "currency_code": "USD" }, "presentment_money": { "amount": "8.00", "currency_code": "USD" } }, "requested_fulfillment_service_id": "LX88888", "discount_allocations": [ { "amount": "8.00", "amount_set": { "shop_money": { "currency_code": "USD", "amount": "8.00" }, "presentment_money": { "currency_code": "USD", "amount": "8.00" } }, "discount_application_index": 1 } ], "title": "SF International", "discounted_price_set": { "shop_money": { "amount": "8.00", "currency_code": "USD" }, "presentment_money": { "amount": "8.00", "currency_code": "USD" } }, "code": "SF", "price": "8.00", "source": "source", "tax_lines": [ { "price": "8.00", "price_set": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } }, "rate": 1, "title": "tax" } ], "shipping_price": "8.00", "discounted_price": "8.00", "phone": "13243214565" } }, "example": [ { "title": "SF International", "phone": "13243214565", "price_set": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } }, "code": "SF", "discount_allocations": [ { "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 } ], "discounted_price_set": { "shop_money": { "amount": "8.00", "currency_code": "USD" }, "presentment_money": { "currency_code": "USD", "amount": "8.00" } }, "requested_fulfillment_service_id": "LX88888", "discounted_price": "8.00", "source": "source", "tax_lines": [ { "price": "8.00", "price_set": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } }, "rate": 1, "title": "tax" } ], "price": "8.00", "shipping_price": "8.00" } ] }, "current_total_price_set": { "name": "current_total_price_set", "description": "Multi-currency information of the sum of taxes, the currency and amount of buyers and sellers are the same", "type": "object", "properties": { "shop_money": { "name": "shop_money", "description": "Sell side currency", "type": "object", "properties": { "currency_code": { "name": "currency_code", "description": "Currency", "type": "string", "example": "USD" }, "amount": { "name": "amount", "description": "Amount", "type": "string", "example": "8.00" } }, "example": { "amount": "8.00", "currency_code": "USD" } }, "presentment_money": { "name": "presentment_money", "description": "Buy side currency", "type": "object", "properties": { "amount": { "name": "amount", "description": "Amount", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "Currency", "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" } } }, "payment_gateway_names": { "name": "payment_gateway_names", "description": "List of payment methods, list of payment methods used for this order, SLpayments, Paypal (PayPal payment), Oceanpay (Oceanpayment), TwoCheckout, AsiaBill, Stripe, Pacypay, WorldPay, COD (cash on delivery), CUSTOM (custom), adjustPay (funding adjustment), Xendit (xendit credit card), XenditOther", "type": "array", "items": { "name": "payment_gateway_names", "description": "List of payment methods, list of payment methods used for this order, SLpayments, Paypal (PayPal payment), Oceanpay (Oceanpayment), TwoCheckout, AsiaBill, Stripe, Pacypay, WorldPay, COD (cash on delivery), CUSTOM (custom), adjustPay (funding adjustment), Xendit (xendit credit card), XenditOther", "type": "string", "example": "PayPal" }, "example": [ "PayPal" ] }, "total_discounts_set": { "name": "total_discounts_set", "description": "Multi-currency information of discount total", "type": "object", "properties": { "presentment_money": { "name": "presentment_money", "description": "Buyer side amount information", "type": "object", "properties": { "currency_code": { "name": "currency_code", "description": "Currency", "type": "string", "example": "USD" }, "amount": { "name": "amount", "description": "Amount, Precision 2", "type": "string", "example": "3.25" } }, "example": { "amount": "3.25", "currency_code": "USD" } }, "shop_money": { "name": "shop_money", "description": "Sell side amount information", "type": "object", "properties": { "currency_code": { "name": "currency_code", "description": "Currency", "type": "string", "example": "USD" }, "amount": { "name": "amount", "description": "Amount, Precision 2", "type": "string", "example": "3.25" } }, "example": { "currency_code": "USD", "amount": "3.25" } } }, "example": { "presentment_money": { "currency_code": "USD", "amount": "3.25" }, "shop_money": { "amount": "3.25", "currency_code": "USD" } } }, "cancel_reason": { "name": "cancel_reason", "description": "Seller's reason for cancellation", "type": "string", "example": "\" don ' t want to buy \"" }, "current_total_tax_set": { "name": "current_total_tax_set", "description": "Multi-currency information of the sum of taxes, the currency and amount of buyers and sellers are the same", "type": "object", "properties": { "presentment_money": { "name": "presentment_money", "description": "Buy side currency", "type": "object", "properties": { "amount": { "name": "amount", "description": "Amount", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "Currency", "type": "string", "example": "USD" } }, "example": { "currency_code": "USD", "amount": "8.00" } }, "shop_money": { "name": "shop_money", "description": "Sell side currency", "type": "object", "properties": { "amount": { "name": "amount", "description": "Amount", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "Currency", "type": "string", "example": "USD" } }, "example": { "amount": "8.00", "currency_code": "USD" } } }, "example": { "shop_money": { "amount": "8.00", "currency_code": "USD" }, "presentment_money": { "amount": "8.00", "currency_code": "USD" } } }, "processed_at": { "name": "processed_at", "description": "Processed_at time , format : 2023-04-12T22 : 59 : 52+08 : 00", "type": "string", "example": "2023-04-12T22:59:52+08:00" }, "total_line_items_price": { "name": "total_line_items_price", "description": "Sum of original prices of goods, precision 2", "type": "string", "example": "8.00" }, "tags": { "name": "tags", "description": "order label", "type": "string", "example": "Tag" }, "checkout_token": { "name": "checkout_token", "description": "Settlement page token", "type": "string", "example": "c2c4a58186b9d96395d7e6b5c2969577" }, "current_total_discounts": { "name": "current_total_discounts", "description": "Sum of discounts, precision 2, marketing offers + artificial discounts", "type": "string", "example": "3.25" }, "note": { "name": "note", "description": "Merchant notes", "type": "string", "example": "Notes" }, "refunds": { "name": "refunds", "description": "Refund list", "type": "array", "items": { "name": "refunds", "description": "Refund list", "type": "object", "properties": { "created_at": { "name": "created_at", "description": "Refund form creation time (see IOS8601 for the format)", "type": "string", "example": "2012-05-01T14:22:25-04:00" }, "id": { "name": "id", "description": "Refund ID", "type": "string", "example": "2605659027312156877634" }, "note": { "name": "note", "description": "Refund Notes", "type": "string", "example": "Refund Notes" }, "order_id": { "name": "order_id", "description": "Order number", "type": "string", "example": "21056577640603870897253153" }, "processed_at": { "name": "processed_at", "description": "Update time (see IOS8601 for the format)", "type": "string", "example": "2012-05-02T14:22:25-04:00" }, "refund_line_items": { "name": "refund_line_items", "description": "Refund Details", "type": "array", "items": { "name": "refund_line_items", "description": "Refund Details", "type": "object", "properties": { "line_item_id": { "name": "line_item_id", "description": "The ID of the product snapshot table, generated by the system, uniquely confirms a product with the order number", "type": "string", "example": "302" }, "total_tax_set": { "name": "total_tax_set", "description": "Total tax amount, multi-currency information", "type": "object", "properties": { "presentment_money": { "name": "presentment_money", "description": "Buy side currency", "type": "object", "properties": { "amount": { "name": "amount", "description": "Amount", "type": "string", "example": "3.25" }, "currency_code": { "name": "currency_code", "description": "Currency", "type": "string", "example": "USD" } }, "example": { "currency_code": "USD", "amount": "3.25" } }, "shop_money": { "name": "shop_money", "description": "Sell side currency", "type": "object", "properties": { "currency_code": { "name": "currency_code", "description": "Currency", "type": "string", "example": "USD" }, "amount": { "name": "amount", "description": "Amount", "type": "string", "example": "3.25" } }, "example": { "amount": "3.25", "currency_code": "USD" } } }, "example": { "shop_money": { "amount": "3.25", "currency_code": "USD" }, "presentment_money": { "amount": "3.25", "currency_code": "USD" } } }, "subtotal_set": { "name": "subtotal_set", "description": "Total refund amount, multi-currency information, same on seller and buyer side", "type": "object", "properties": { "shop_money": { "name": "shop_money", "description": "Sell side amount information", "type": "object", "properties": { "currency_code": { "name": "currency_code", "description": "Currency", "type": "string", "example": "USD" }, "amount": { "name": "amount", "description": "Amount, Precision 2", "type": "string", "example": "3.25" } }, "example": { "amount": "3.25", "currency_code": "USD" } }, "presentment_money": { "name": "presentment_money", "description": "Buy side currency", "type": "object", "properties": { "amount": { "name": "amount", "description": "Amount", "type": "string", "example": "3.25" }, "currency_code": { "name": "currency_code", "description": "Currency", "type": "string", "example": "USD" } }, "example": { "amount": "3.25", "currency_code": "USD" } } }, "example": { "presentment_money": { "currency_code": "USD", "amount": "3.25" }, "shop_money": { "amount": "3.25", "currency_code": "USD" } } }, "total_tax": { "name": "total_tax", "description": "Tax amount of refunded goods, precision 2", "type": "double", "example": 0 }, "line_item": { "name": "line_item", "description": "Refund Product line", "type": "object", "properties": { "product_id": { "name": "product_id", "description": "SPU serial number", "type": "string", "example": "16056761559984840457934011" }, "title": { "name": "title", "description": "Product title", "type": "string", "example": "Beautiful skirt" }, "vendor": { "name": "vendor", "description": "Supplier", "type": "string", "example": "Supplier" }, "taxable": { "name": "taxable", "description": "Tax or not？", "type": "boolean", "example": true }, "attribute": { "name": "attribute", "description": "Product attributes : name-attribute value multiple comma \" , \" division like : color-red , size-x", "type": "string", "example": "red" }, "id": { "name": "id", "description": "The ID of the product snapshot table, generated by the system, uniquely confirms a product with the order number", "type": "string", "example": "312" }, "fulfillment_service": { "name": "fulfillment_service", "description": "Logistics company name", "type": "string", "example": "Sf" }, "price": { "name": "price", "description": "Commodity price, precision 2", "type": "string", "example": "3.25" }, "quantity": { "name": "quantity", "description": "Quantity of items in the order", "type": "integer", "example": 2 }, "fulfillment_status": { "name": "fulfillment_status", "description": "The shipping status of the product, shipping status, fulfilled-shipped; partial-partially shipped; null-unshipped;", "type": "string", "example": "fulfilled" }, "requires_shipping": { "name": "requires_shipping", "description": "Shipping or not", "type": "boolean", "example": true }, "grams": { "name": "grams", "description": "Weight ( grams )", "type": "double", "example": 100 }, "sku": { "name": "sku", "description": "Product code, barCode", "type": "string", "example": "18056761559987524812644011" }, "fulfillable_quantity": { "name": "fulfillable_quantity", "description": "Available quantity", "type": "integer", "example": 2 }, "tax_lines": { "name": "tax_lines", "description": "Tax information", "type": "array", "items": { "name": "tax_lines", "description": "Tax information", "type": "object", "properties": { "rate": { "name": "rate", "description": "Tax rate", "type": "double", "example": 1 }, "title": { "name": "title", "description": "Tax title", "type": "string", "example": "tax" }, "price": { "name": "price", "description": "Tax, precision 2", "type": "string", "example": "3.25" }, "price_set": { "name": "price_set", "description": "Multi-currency information of tax", "type": "object", "properties": { "presentment_money": { "name": "presentment_money", "description": "Buy side currency", "type": "object", "properties": { "amount": { "name": "amount", "description": "Amount, Precision 2", "type": "string", "example": "3.25" }, "currency_code": { "name": "currency_code", "description": "Currency", "type": "string", "example": "USD" } }, "example": { "currency_code": "USD", "amount": "3.25" } }, "shop_money": { "name": "shop_money", "description": "Sell side amount information", "type": "object", "properties": { "currency_code": { "name": "currency_code", "description": "Currency", "type": "string", "example": "USD" }, "amount": { "name": "amount", "description": "Amount", "type": "string", "example": "3.25" } }, "example": { "currency_code": "USD", "amount": "3.25" } } }, "example": { "presentment_money": { "currency_code": "USD", "amount": "3.25" }, "shop_money": { "currency_code": "USD", "amount": "3.25" } } } }, "example": { "price": "3.25", "price_set": { "presentment_money": { "currency_code": "USD", "amount": "3.25" }, "shop_money": { "currency_code": "USD", "amount": "3.25" } }, "rate": 1, "title": "tax" } }, "example": [ { "title": "tax", "price": "3.25", "price_set": { "presentment_money": { "amount": "3.25", "currency_code": "USD" }, "shop_money": { "amount": "3.25", "currency_code": "USD" } }, "rate": 1 } ] }, "name": { "name": "name", "description": "SKU title, same as title", "type": "string", "example": "test-002" }, "variant_title": { "name": "variant_title", "description": "Commodity attribute value, multiple divided by \" / \", such as: \"155 / red / large\"", "type": "string", "example": "big" }, "variant_id": { "name": "variant_id", "description": "Product SKU serial number", "type": "string", "example": "18056761559987524812644011" } }, "example": { "grams": 100, "tax_lines": [ { "price": "3.25", "price_set": { "presentment_money": { "amount": "3.25", "currency_code": "USD" }, "shop_money": { "currency_code": "USD", "amount": "3.25" } }, "rate": 1, "title": "tax" } ], "variant_title": "big", "vendor": "Supplier", "variant_id": "18056761559987524812644011", "requires_shipping": true, "fulfillment_status": "fulfilled", "price": "3.25", "fulfillment_service": "Sf", "name": "test-002", "product_id": "16056761559984840457934011", "quantity": 2, "sku": "18056761559987524812644011", "title": "Beautiful skirt", "attribute": "red", "fulfillable_quantity": 2, "id": "312", "taxable": true } }, "quantity": { "name": "quantity", "description": "Quantity, quantity of goods", "type": "integer", "example": 2 }, "restock_type": { "name": "restock_type", "description": "Inventory return type, no_restock-not returned, cancel-cancelled, return-returned only not returned", "type": "string", "example": "no_restock" }, "id": { "name": "id", "description": "Order number for this adjustment of the single link", "type": "string", "example": "2605659027312156877634" }, "subtotal": { "name": "subtotal", "description": "Total refund amount, precision 2", "type": "double", "example": 3.25 } }, "example": { "total_tax": 0, "quantity": 2, "id": "2605659027312156877634", "line_item": { "variant_id": "18056761559987524812644011", "title": "Beautiful skirt", "tax_lines": [ { "price": "3.25", "price_set": { "presentment_money": { "amount": "3.25", "currency_code": "USD" }, "shop_money": { "amount": "3.25", "currency_code": "USD" } }, "rate": 1, "title": "tax" } ], "name": "test-002", "variant_title": "big", "fulfillment_status": "fulfilled", "vendor": "Supplier", "id": "312", "taxable": true, "quantity": 2, "sku": "18056761559987524812644011", "grams": 100, "requires_shipping": true, "fulfillable_quantity": 2, "product_id": "16056761559984840457934011", "attribute": "red", "fulfillment_service": "Sf", "price": "3.25" }, "restock_type": "no_restock", "total_tax_set": { "presentment_money": { "amount": "3.25", "currency_code": "USD" }, "shop_money": { "amount": "3.25", "currency_code": "USD" } }, "subtotal_set": { "presentment_money": { "amount": "3.25", "currency_code": "USD" }, "shop_money": { "amount": "3.25", "currency_code": "USD" } }, "line_item_id": "302", "subtotal": 3.25 } }, "example": [ { "total_tax": 0, "line_item": { "sku": "18056761559987524812644011", "taxable": true, "vendor": "Supplier", "price": "3.25", "id": "312", "quantity": 2, "variant_id": "18056761559987524812644011", "requires_shipping": true, "title": "Beautiful skirt", "grams": 100, "variant_title": "big", "attribute": "red", "tax_lines": [ { "price": "3.25", "price_set": { "shop_money": { "amount": "3.25", "currency_code": "USD" }, "presentment_money": { "currency_code": "USD", "amount": "3.25" } }, "rate": 1, "title": "tax" } ], "fulfillable_quantity": 2, "product_id": "16056761559984840457934011", "fulfillment_service": "Sf", "name": "test-002", "fulfillment_status": "fulfilled" }, "subtotal_set": { "shop_money": { "amount": "3.25", "currency_code": "USD" }, "presentment_money": { "amount": "3.25", "currency_code": "USD" } }, "line_item_id": "302", "restock_type": "no_restock", "total_tax_set": { "presentment_money": { "amount": "3.25", "currency_code": "USD" }, "shop_money": { "amount": "3.25", "currency_code": "USD" } }, "id": "2605659027312156877634", "quantity": 2, "subtotal": 3.25 } ] }, "transactions": { "name": "transactions", "description": "Refund transaction information", "type": "array", "items": { "name": "transactions", "description": "Refund transaction information", "type": "object", "properties": { "status": { "name": "status", "description": "Handling status, pending, failure, success, and error", "type": "string", "example": "pending" }, "currency": { "name": "currency", "description": "Currency", "type": "string", "example": "USD" }, "order_id": { "name": "order_id", "description": "Order number", "type": "string", "example": "21056577640603870897253153" }, "user_id": { "name": "user_id", "description": "Buyer ID", "type": "string", "example": "4201057495" }, "amount": { "name": "amount", "description": "Refund amount , accuracy 2", "type": "string", "example": "3.25" }, "created_at": { "name": "created_at", "description": "Creation time", "type": "string", "example": "2012-05-01T14:22:25-04:00" }, "id": { "name": "id", "description": "Refund ID", "type": "string", "example": "2605659027312156877634" }, "processed_at": { "name": "processed_at", "description": "Refund order update time ( format see IOS8601 )", "type": "string", "example": "2012-05-01T14:22:25-04:00" }, "kind": { "name": "kind", "description": "Transaction type (authorization, capture, sale, void, refund)", "type": "string", "example": "authorization" } }, "example": { "user_id": "4201057495", "kind": "authorization", "processed_at": "2012-05-01T14:22:25-04:00", "status": "pending", "amount": "3.25", "currency": "USD", "order_id": "21056577640603870897253153", "id": "2605659027312156877634", "created_at": "2012-05-01T14:22:25-04:00" } }, "example": [ { "status": "pending", "amount": "3.25", "created_at": "2012-05-01T14:22:25-04:00", "currency": "USD", "order_id": "21056577640603870897253153", "user_id": "4201057495", "processed_at": "2012-05-01T14:22:25-04:00", "id": "2605659027312156877634", "kind": "authorization" } ] }, "user_id": { "name": "user_id", "description": "User ID", "type": "string", "example": "4201057495" } }, "example": { "transactions": [ { "currency": "USD", "kind": "authorization", "order_id": "21056577640603870897253153", "id": "2605659027312156877634", "user_id": "4201057495", "created_at": "2012-05-01T14:22:25-04:00", "status": "pending", "amount": "3.25", "processed_at": "2012-05-01T14:22:25-04:00" } ], "user_id": "4201057495", "created_at": "2012-05-01T14:22:25-04:00", "id": "2605659027312156877634", "note": "Refund Notes", "order_id": "21056577640603870897253153", "processed_at": "2012-05-02T14:22:25-04:00", "refund_line_items": [ { "line_item_id": "302", "id": "2605659027312156877634", "restock_type": "no_restock", "quantity": 2, "total_tax": 0, "subtotal": 3.25, "subtotal_set": { "presentment_money": { "currency_code": "USD", "amount": "3.25" }, "shop_money": { "amount": "3.25", "currency_code": "USD" } }, "line_item": { "fulfillment_service": "Sf", "attribute": "red", "grams": 100, "name": "test-002", "title": "Beautiful skirt", "fulfillment_status": "fulfilled", "variant_id": "18056761559987524812644011", "product_id": "16056761559984840457934011", "tax_lines": [ { "price_set": { "shop_money": { "amount": "3.25", "currency_code": "USD" }, "presentment_money": { "amount": "3.25", "currency_code": "USD" } }, "rate": 1, "title": "tax", "price": "3.25" } ], "fulfillable_quantity": 2, "quantity": 2, "price": "3.25", "requires_shipping": true, "taxable": true, "sku": "18056761559987524812644011", "vendor": "Supplier", "id": "312", "variant_title": "big" }, "total_tax_set": { "presentment_money": { "amount": "3.25", "currency_code": "USD" }, "shop_money": { "amount": "3.25", "currency_code": "USD" } } } ] } }, "example": [ { "processed_at": "2012-05-02T14:22:25-04:00", "refund_line_items": [ { "total_tax_set": { "presentment_money": { "currency_code": "USD", "amount": "3.25" }, "shop_money": { "amount": "3.25", "currency_code": "USD" } }, "line_item": { "grams": 100, "variant_id": "18056761559987524812644011", "fulfillable_quantity": 2, "id": "312", "sku": "18056761559987524812644011", "variant_title": "big", "attribute": "red", "title": "Beautiful skirt", "taxable": true, "name": "test-002", "fulfillment_service": "Sf", "requires_shipping": true, "price": "3.25", "vendor": "Supplier", "quantity": 2, "tax_lines": [ { "title": "tax", "price": "3.25", "price_set": { "presentment_money": { "amount": "3.25", "currency_code": "USD" }, "shop_money": { "amount": "3.25", "currency_code": "USD" } }, "rate": 1 } ], "fulfillment_status": "fulfilled", "product_id": "16056761559984840457934011" }, "line_item_id": "302", "id": "2605659027312156877634", "restock_type": "no_restock", "subtotal": 3.25, "subtotal_set": { "presentment_money": { "amount": "3.25", "currency_code": "USD" }, "shop_money": { "amount": "3.25", "currency_code": "USD" } }, "total_tax": 0, "quantity": 2 } ], "transactions": [ { "processed_at": "2012-05-01T14:22:25-04:00", "created_at": "2012-05-01T14:22:25-04:00", "currency": "USD", "id": "2605659027312156877634", "kind": "authorization", "order_id": "21056577640603870897253153", "status": "pending", "user_id": "4201057495", "amount": "3.25" } ], "user_id": "4201057495", "created_at": "2012-05-01T14:22:25-04:00", "id": "2605659027312156877634", "note": "Refund Notes", "order_id": "21056577640603870897253153" } ] }, "current_subtotal_price": { "name": "current_subtotal_price", "description": "Sum of current products, total price of products * quantity", "type": "string", "example": "78.08" }, "line_items": { "name": "line_items", "description": "Order product snapshot information", "type": "array", "items": { "name": "line_items", "description": "Order product snapshot information", "type": "object", "properties": { "discount_allocations": { "name": "discount_allocations", "description": "Marketing discount detail amount multi-currency", "type": "array", "items": { "name": "discount_allocations", "description": "Marketing discount detail amount multi-currency", "type": "object", "properties": { "amount": { "name": "amount", "description": "Discount detail amount", "type": "string", "example": "8.00" }, "amount_set": { "name": "amount_set", "description": "Discount Details Amount Multi-Currency", "type": "object", "properties": { "presentment_money": { "name": "presentment_money", "description": "payment currency", "type": "object", "properties": { "amount": { "name": "amount", "description": "Amount, Precision 2", "type": "string", "example": "8.00" }, "currency_code": { "name": "currency_code", "description": "Currency", "type": "string", "example": "USD" } }, "example": { "currency_code": "USD", "amount": "8.00" } }, "shop_money": { "name": "shop_money", "description": "Store currency", "type": "object", "properties": { "currency_code": { "name": "currency_code", "description": "Currency", "type": "string", "example": "USD" }, "amount": { "name": "amount", "description": "Amount, Precision 2", "type": "string", "example": "8.00" } }, "example": { "amount": "8.00", "currency_code": "USD" } } }, "example": { "presentment_money": { "currency_code": "USD", "amount": "8.00" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } } }, "discount_application_index": { "name": "discount_application_index", "description": "Indicate the location in the discount details", "type": "integer", "example": 1 } }, "example": { "discount_application_index": 1, "amount": "8.00", "amount_set": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "currency_code": "USD", "amount": "8.00" } } } }, "example": [ { "amount": "8.00", "amount_set": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "currency_code": "USD", "amount": "8.00" } }, "discount_application_index": 1 } ] }, "title": { "name": "title", "description": "Product title", "type": "string", "example": "Nice looking skirt" }, "name": { "name": "name", "description": "SKU title, same as title", "type": "string", "example": "Product title" }, "variant_id": { "name": "variant_id", "description": "Product SKU serial number", "type": "string", "example": "18056761559987524812644011" }, "product_id": { "name": "product_id", "description": "SPU serial number", "type": "string", "example": "16056761559984840457934011" }, "attribute": { "name": "attribute", "description": "Product attributes : name-attribute value multiple comma \" , \" division like : color-red , size-x", "type": "string", "example": "red" }, "location_id": { "name": "location_id", "description": "The location corresponding to the store in the pos scene", "type": "string", "example": "5327026538935748524" }, "fulfillment_status": { "name": "fulfillment_status", "description": "The shipping status of the product, shipping status, fulfilled-shipped; partial-partially shipped; null-unshipped;", "type": "string", "example": "fulfilled" }, "id": { "name": "id", "description": "The ID of the product snapshot table, generated by the system, uniquely confirms a product with the order number", "type": "string", "example": "417" }, "vendor": { "name": "vendor", "description": "Supplier", "type": "string", "example": "Supplier" }, "tax_lines": { "name": "tax_lines", "description": "Tax information", "type": "array", "items": { "name": "tax_lines", "description": "Tax information", "type": "object", "properties": { "price_set": { "name": "price_set", "description": "Multi-currency information of tax", "type": "object", "properties": { "shop_money": { "name": "shop_money", "description": "Sell side currency", "type": "object", "properties": { "amount": { "name": "amount", "description": "Amount", "type": "string", "example": "3.25" }, "currency_code": { "name": "currency_code", "description": "Currency", "type": "string", "example": "USD" } }, "example": { "amount": "3.25", "currency_code": "USD" } }, "presentment_money": { "name": "presentment_money", "description": "Buy side currency", "type": "object", "properties": { "amount": { "name": "amount", "description": "Amount", "type": "string", "example": "3.25" }, "currency_code": { "name": "currency_code", "description": "Currency", "type": "string", "example": "USD" } }, "example": { "amount": "3.25", "currency_code": "USD" } } }, "example": { "shop_money": { "amount": "3.25", "currency_code": "USD" }, "presentment_money": { "amount": "3.25", "currency_code": "USD" } } }, "rate": { "name": "rate", "description": "Tax rate", "type": "double", "example": 1 }, "title": { "name": "title", "description": "Tax name", "type": "string", "example": "tax" }, "type": { "name": "type", "description": "Tax fee type, used to distinguish whether it is commodity tax or freight tax, the enumerated values ​​are as follows product_tax: commodity tax shipping_tax: freight tax", "type": "string", "example": "shipping_tax" }, "price": { "name": "price", "description": "Tax, precision 2", "type": "string", "example": "3.25" } }, "example": { "type": "shipping_tax", "price": "3.25", "price_set": { "shop_money": { "amount": "3.25", "currency_code": "USD" }, "presentment_money": { "amount": "3.25", "currency_code": "USD" } }, "rate": 1, "title": "tax" } }, "example": [ { "rate": 1, "title": "tax", "type": "shipping_tax", "price": "3.25", "price_set": { "presentment_money": { "currency_code": "USD", "amount": "3.25" }, "shop_money": { "amount": "3.25", "currency_code": "USD" } } } ] }, "quantity": { "name": "quantity", "description": "Quantity of items in the order", "type": "integer", "example": 2 }, "grams": { "name": "grams", "description": "Weight ( grams )", "type": "double", "example": 100 }, "requires_shipping": { "name": "requires_shipping", "description": "Shipping or not", "type": "boolean", "example": true }, "variant_title": { "name": "variant_title", "description": "Commodity attribute value, multiple divided by \" / \", such as: \"155 / red / large\"", "type": "string", "example": "big" }, "sku": { "name": "sku", "description": "Product code, barCode", "type": "string", "example": "18056761559987524812644011" }, "price": { "name": "price", "description": "Commodity price, precision 2", "type": "string", "example": "3.25" }, "taxable": { "name": "taxable", "description": "Tax or not？", "type": "boolean", "example": true }, "fulfillment_service": { "name": "fulfillment_service", "description": "Logistics company name", "type": "string", "example": "Sf" }, "properties": { "name": "properties", "description": "Product customization information", "type": "array", "items": { "name": "properties", "description": "Product customization information", "type": "object", "properties": { "additional": { "name": "additional", "description": "Additional Fields for Custom Items", "type": "string", "example": "Additional field" }, "name": { "name": "name", "description": "Custom attribute name", "type": "string", "example": "Attribute name" }, "type": { "name": "type", "description": "Attribute type, text-character, the display format is name: value; picture-picture, the display type is name: get the rendered thumbnail through URLs; link-hyperlink, the display type is name: value, supports clicking on the link to jump to urls First", "type": "string", "example": "text" }, "urls": { "name": "urls", "description": "URL resource list", "type": "array", "items": { "name": "urls", "description": "URL resource list", "type": "string", "example": "https://www.url.com" }, "example": [ "https://www.url.com" ] }, "value": { "name": "value", "description": "Custom attribute values", "type": "string", "example": "Attribute value" } }, "example": { "type": "text", "urls": [ "https://www.url.com" ], "value": "Attribute value", "additional": "Additional field", "name": "Attribute name" } }, "example": [ { "type": "text", "urls": [ "https://www.url.com" ], "value": "Attribute value", "additional": "Additional field", "name": "Attribute name" } ] }, "tags": { "name": "tags", "description": "Commodity tags (separated by multiple commas)", "type": "string", "example": "Tag 1 , cute" }, "fulfillable_quantity": { "name": "fulfillable_quantity", "description": "Available quantity", "type": "integer", "example": 1 } }, "example": { "grams": 100, "product_id": "16056761559984840457934011", "id": "417", "location_id": "5327026538935748524", "title": "Nice looking skirt", "name": "Product title", "sku": "18056761559987524812644011", "tags": "Tag 1 , cute", "taxable": true, "variant_id": "18056761559987524812644011", "vendor": "Supplier", "fulfillment_status": "fulfilled", "fulfillment_service": "Sf", "attribute": "red", "variant_title": "big", "price": "3.25", "tax_lines": [ { "price_set": { "presentment_money": { "amount": "3.25", "currency_code": "USD" }, "shop_money": { "amount": "3.25", "currency_code": "USD" } }, "rate": 1, "title": "tax", "type": "shipping_tax", "price": "3.25" } ], "properties": [ { "value": "Attribute value", "additional": "Additional field", "name": "Attribute name", "type": "text", "urls": [ "https://www.url.com" ] } ], "discount_allocations": [ { "amount": "8.00", "amount_set": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "currency_code": "USD", "amount": "8.00" } }, "discount_application_index": 1 } ], "fulfillable_quantity": 1, "requires_shipping": true, "quantity": 2 } }, "example": [ { "id": "417", "fulfillable_quantity": 1, "requires_shipping": true, "attribute": "red", "variant_title": "big", "location_id": "5327026538935748524", "price": "3.25", "vendor": "Supplier", "grams": 100, "tax_lines": [ { "title": "tax", "type": "shipping_tax", "price": "3.25", "price_set": { "presentment_money": { "amount": "3.25", "currency_code": "USD" }, "shop_money": { "currency_code": "USD", "amount": "3.25" } }, "rate": 1 } ], "variant_id": "18056761559987524812644011", "fulfillment_status": "fulfilled", "quantity": 2, "product_id": "16056761559984840457934011", "tags": "Tag 1 , cute", "title": "Nice looking skirt", "properties": [ { "value": "Attribute value", "additional": "Additional field", "name": "Attribute name", "type": "text", "urls": [ "https://www.url.com" ] } ], "discount_allocations": [ { "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 } ], "sku": "18056761559987524812644011", "taxable": true, "name": "Product title", "fulfillment_service": "Sf" } ] }, "current_total_tax": { "name": "current_total_tax", "description": "Total tax, product tax + shipping tax", "type": "string", "example": "8.00" }, "presentment_currency": { "name": "presentment_currency", "description": "Buy side currency, same as sell side currency", "type": "string", "example": "USD" }, "total_tax": { "name": "total_tax", "description": "Sum of taxes, precision 2, commodity tax + shipping tax", "type": "string", "example": "8.00" }, "name": { "name": "name", "description": "Custom order number", "type": "string", "example": "test1001" }, "cart_token": { "name": "cart_token", "description": "Shopping cart token", "type": "string", "example": "c2c4a58186b9d96395d7e6b5c2969577" }, "customer_locale": { "name": "customer_locale", "description": "Buyer country, language code + country name abbreviation", "type": "string", "example": "enCN" }, "taxes_included": { "name": "taxes_included", "description": "Does the total include tax?", "type": "boolean", "example": false }, "customer": { "name": "customer", "description": "Buyer information", "type": "object", "properties": { "first_name": { "name": "first_name", "description": "First name", "type": "string", "example": "Tom" }, "id": { "name": "id", "description": "User ID", "type": "string", "example": "4201057495" }, "created_at": { "name": "created_at", "description": "Buyer creation time (see IOS8601 for the format)", "type": "string", "example": "2012-05-01T14:22:25-04:00" }, "currency": { "name": "currency", "description": "Currency", "type": "string", "example": "USD" }, "phone": { "name": "phone", "description": "User mobile phone number", "type": "string", "example": "19872121232" }, "updated_at": { "name": "updated_at", "description": "Buyer update time", "type": "string", "example": "2012-05-01T14:22:25-04:00" }, "area_code": { "name": "area_code", "description": "Phone area code", "type": "string", "example": "+86" }, "addresses": { "name": "addresses", "description": "Buyer address information", "type": "object", "properties": { "address2": { "name": "address2", "description": "Detailed address 2, optional", "type": "string", "example": "Address 2" }, "first_name": { "name": "first_name", "description": "Last name", "type": "string", "example": "Tom" }, "address1": { "name": "address1", "description": "Detailed address 1", "type": "string", "example": "Address 1" }, "phone": { "name": "phone", "description": "Phone", "type": "string", "example": "13652133421" }, "province": { "name": "province", "description": "Province", "type": "string", "example": "California" }, "city": { "name": "city", "description": "City", "type": "string", "example": "New York" }, "name": { "name": "name", "description": "Full name", "type": "string", "example": "Tom Washington " }, "country_code": { "name": "country_code", "description": "Country code", "type": "string", "example": "US" }, "province_code": { "name": "province_code", "description": "Province code", "type": "string", "example": "4300006" }, "zip": { "name": "zip", "description": "Postal code", "type": "string", "example": "52134" }, "country": { "name": "country", "description": "Country", "type": "string", "example": "Usa" }, "last_name": { "name": "last_name", "description": "First name", "type": "string", "example": "Washington" } }, "example": { "zip": "52134", "last_name": "Washington", "province_code": "4300006", "address1": "Address 1", "name": "Tom Washington ", "first_name": "Tom", "country_code": "US", "province": "California", "country": "Usa", "address2": "Address 2", "city": "New York", "phone": "13652133421" } }, "email": { "name": "email", "description": "User mailbox", "type": "string", "example": "test001@Gmail.com" }, "last_name": { "name": "last_name", "description": "Last name", "type": "string", "example": "Washington" } }, "example": { "addresses": { "last_name": "Washington", "zip": "52134", "country": "Usa", "province_code": "4300006", "address2": "Address 2", "name": "Tom Washington ", "province": "California", "city": "New York", "address1": "Address 1", "phone": "13652133421", "first_name": "Tom", "country_code": "US" }, "currency": "USD", "created_at": "2012-05-01T14:22:25-04:00", "email": "test001@Gmail.com", "id": "4201057495", "last_name": "Washington", "updated_at": "2012-05-01T14:22:25-04:00", "area_code": "+86", "first_name": "Tom", "phone": "19872121232" } }, "cancelled_at": { "name": "cancelled_at", "description": "Order cancellation time (end) (see IOS8601 for the format), 2012-05-01T14:22:25-04:00", "type": "string", "example": "2012-05-01T14:22:25-04:00" }, "tax_lines": { "name": "tax_lines", "description": "Tax information", "type": "array", "items": { "name": "tax_lines", "description": "Tax information", "type": "object", "properties": { "price_set": { "name": "price_set", "description": "Multi-currency information of tax", "type": "object", "properties": { "presentment_money": { "name": "presentment_money", "description": "Buyer side amount information", "type": "object", "properties": { "currency_code": { "name": "currency_code", "description": "Currency", "type": "string", "example": "" }, "amount": { "name": "amount", "description": "Amount, Precision 2", "type": "string", "example": "USD" } }, "example": { "amount": "USD", "currency_code": "" } }, "shop_money": { "name": "shop_money", "description": "Sell side amount information", "type": "object", "properties": { "amount": { "name": "amount", "description": "Amount, Precision 2", "type": "string", "example": "3.25" }, "currency_code": { "name": "currency_code", "description": "Currency", "type": "string", "example": "USD" } }, "example": { "currency_code": "USD", "amount": "3.25" } } }, "example": { "presentment_money": { "amount": "USD", "currency_code": "" }, "shop_money": { "amount": "3.25", "currency_code": "USD" } } }, "rate": { "name": "rate", "description": "Tax rate", "type": "double", "example": 1 }, "title": { "name": "title", "description": "Tax name", "type": "string", "example": "tax" }, "price": { "name": "price", "description": "Tax amount", "type": "string", "example": "3.25" } }, "example": { "title": "tax", "price": "3.25", "price_set": { "presentment_money": { "amount": "USD", "currency_code": "" }, "shop_money": { "currency_code": "USD", "amount": "3.25" } }, "rate": 1 } }, "example": [ { "price_set": { "presentment_money": { "amount": "USD", "currency_code": "" }, "shop_money": { "amount": "3.25", "currency_code": "USD" } }, "rate": 1, "title": "tax", "price": "3.25" } ] }, "tax_type": { "name": "tax_type", "description": "Types of tax ID", "type": "string", "example": "type" }, "client_details": { "name": "client_details", "description": "Client Details", "type": "object", "properties": { "browser_ip": { "name": "browser_ip", "description": "Client ip address", "type": "string", "example": "157.119.232.35" }, "session_hash": { "name": "session_hash", "description": "Member session encryption information", "type": "string", "example": "c2c4a58186b9d96395d7e6b5c2969577" }, "user_agent": { "name": "user_agent", "description": "Client Proxy", "type": "string", "example": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/106.0.0.0 Sa" } }, "example": { "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/106.0.0.0 Sa", "browser_ip": "157.119.232.35", "session_hash": "c2c4a58186b9d96395d7e6b5c2969577" } }, "fulfillments": { "name": "fulfillments", "description": "Package information", "type": "array", "items": { "name": "fulfillments", "description": "Package information", "type": "object", "properties": { "id": { "name": "id", "description": "Package number", "type": "string", "example": "22046737798141702810214336" }, "tracking_company": { "name": "tracking_company", "description": "Logistics company name", "type": "string", "example": "SF International" }, "tracking_url": { "name": "tracking_url", "description": "Logistics company URL", "type": "string", "example": "https://www.sf-international.com/" }, "updated_at": { "name": "updated_at", "description": "Update time (see IOS8601 for the format)", "type": "string", "example": "2012-05-01T14:22:25-04:00" }, "shipment_status": { "name": "shipment_status", "description": "Package tracking", "type": "string", "example": "fulfilled" }, "status": { "name": "status", "description": "Logistics delivery status, success-shipped; cancelled-cancelled;", "type": "string", "example": "cancelled" }, "created_at": { "name": "created_at", "description": "Creation time (see IOS8601 for the format)", "type": "string", "example": "2012-05-01T14:22:25-04:00" }, "line_items": { "name": "line_items", "description": "Product list", "type": "array", "items": { "name": "line_items", "description": "Product list", "type": "object", "properties": { "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": "Shipping or not", "type": "boolean", "example": false }, "variant_id": { "name": "variant_id", "description": "Product SKU serial number", "type": "string", "example": "18056761559987524812644011" }, "sku": { "name": "sku", "description": "Product code, barCode", "type": "string", "example": "18056761559987524812644011" }, "id": { "name": "id", "description": "The ID of the product snapshot table, generated by the system, uniquely confirms a product with the order number", "type": "string", "example": "312" }, "name": { "name": "name", "description": "SKU title, same as title", "type": "string", "example": "Product name" }, "vendor": { "name": "vendor", "description": "Supplier", "type": "string", "example": "Supplier" }, "variant_title": { "name": "variant_title", "description": "Commodity attribute value, multiple divided by \" / \", such as: \"155 / red / large\"", "type": "string", "example": "big" }, "taxable": { "name": "taxable", "description": "Tax or not？", "type": "boolean", "example": true }, "fulfillable_quantity": { "name": "fulfillable_quantity", "description": "Available quantity", "type": "integer", "example": 1 }, "fulfillment_status": { "name": "fulfillment_status", "description": "The shipping status of the product, shipping status, fulfilled-shipped; partial-partially shipped; null-unshipped;", "type": "string", "example": "fulfilled" }, "title": { "name": "title", "description": "Product title", "type": "string", "example": "Beautiful skirt" }, "fulfillment_service": { "name": "fulfillment_service", "description": "Logistics company name", "type": "string", "example": "Sf" }, "price": { "name": "price", "description": "Commodity price, precision 2", "type": "string", "example": "23.09" }, "tax_lines": { "name": "tax_lines", "description": "Tax information", "type": "array", "items": { "name": "tax_lines", "description": "Tax information", "type": "object", "properties": { "rate": { "name": "rate", "description": "Tax rate", "type": "double", "example": 1 }, "title": { "name": "title", "description": "Tax name", "type": "string", "example": "tax" }, "price": { "name": "price", "description": "Tax, precision 2", "type": "string", "example": "3.25" }, "price_set": { "name": "price_set", "description": "Multi-currency information of tax", "type": "object", "properties": { "presentment_money": { "name": "presentment_money", "description": "Currency information", "type": "object", "properties": { "amount": { "name": "amount", "description": "Amount", "type": "string", "example": "3.25" }, "currency_code": { "name": "currency_code", "description": "Currency", "type": "string", "example": "USD" } }, "example": { "amount": "3.25", "currency_code": "USD" } }, "shop_money": { "name": "shop_money", "description": "Sell side amount information", "type": "object", "properties": { "currency_code": { "name": "currency_code", "description": "Currency", "type": "string", "example": "USD" }, "amount": { "name": "amount", "description": "Amount", "type": "string", "example": "3.25" } }, "example": { "currency_code": "USD", "amount": "3.25" } } }, "example": { "presentment_money": { "amount": "3.25", "currency_code": "USD" }, "shop_money": { "amount": "3.25", "currency_code": "USD" } } } }, "example": { "title": "tax", "price": "3.25", "price_set": { "presentment_money": { "amount": "3.25", "currency_code": "USD" }, "shop_money": { "currency_code": "USD", "amount": "3.25" } }, "rate": 1 } }, "example": [ { "title": "tax", "price": "3.25", "price_set": { "presentment_money": { "amount": "3.25", "currency_code": "USD" }, "shop_money": { "amount": "3.25", "currency_code": "USD" } }, "rate": 1 } ] }, "grams": { "name": "grams", "description": "Weight ( grams )", "type": "double", "example": 100 }, "attribute": { "name": "attribute", "description": "Product attributes : name-attribute value multiple comma \" , \" division like : color-red , size-x", "type": "string", "example": "red" } }, "example": { "requires_shipping": false, "grams": 100, "name": "Product name", "taxable": true, "vendor": "Supplier", "sku": "18056761559987524812644011", "variant_title": "big", "id": "312", "variant_id": "18056761559987524812644011", "attribute": "red", "product_id": "16056761559984840457934011", "quantity": 1, "title": "Beautiful skirt", "fulfillment_service": "Sf", "price": "23.09", "tax_lines": [ { "price_set": { "shop_money": { "amount": "3.25", "currency_code": "USD" }, "presentment_money": { "amount": "3.25", "currency_code": "USD" } }, "rate": 1, "title": "tax", "price": "3.25" } ], "fulfillable_quantity": 1, "fulfillment_status": "fulfilled" } }, "example": [ { "vendor": "Supplier", "fulfillment_status": "fulfilled", "variant_title": "big", "name": "Product name", "grams": 100, "fulfillment_service": "Sf", "quantity": 1, "title": "Beautiful skirt", "variant_id": "18056761559987524812644011", "price": "23.09", "taxable": true, "fulfillable_quantity": 1, "requires_shipping": false, "attribute": "red", "product_id": "16056761559984840457934011", "id": "312", "tax_lines": [ { "price": "3.25", "price_set": { "shop_money": { "amount": "3.25", "currency_code": "USD" }, "presentment_money": { "amount": "3.25", "currency_code": "USD" } }, "rate": 1, "title": "tax" } ], "sku": "18056761559987524812644011" } ] }, "tracking_number": { "name": "tracking_number", "description": "Third party tracking number", "type": "string", "example": "yun0001" }, "name": { "name": "name", "description": "invoice short number", "type": "string", "example": "1032-F2" }, "order_id": { "name": "order_id", "description": "Order number", "type": "string", "example": "21056577640603870897253153" } }, "example": { "tracking_company": "SF International", "updated_at": "2012-05-01T14:22:25-04:00", "tracking_url": "https://www.sf-international.com/", "id": "22046737798141702810214336", "name": "1032-F2", "status": "cancelled", "created_at": "2012-05-01T14:22:25-04:00", "order_id": "21056577640603870897253153", "shipment_status": "fulfilled", "tracking_number": "yun0001", "line_items": [ { "attribute": "red", "variant_id": "18056761559987524812644011", "tax_lines": [ { "rate": 1, "title": "tax", "price": "3.25", "price_set": { "presentment_money": { "amount": "3.25", "currency_code": "USD" }, "shop_money": { "amount": "3.25", "currency_code": "USD" } } } ], "fulfillment_status": "fulfilled", "taxable": true, "price": "23.09", "requires_shipping": false, "quantity": 1, "id": "312", "title": "Beautiful skirt", "grams": 100, "variant_title": "big", "vendor": "Supplier", "fulfillment_service": "Sf", "name": "Product name", "product_id": "16056761559984840457934011", "sku": "18056761559987524812644011", "fulfillable_quantity": 1 } ] } }, "example": [ { "shipment_status": "fulfilled", "name": "1032-F2", "id": "22046737798141702810214336", "tracking_number": "yun0001", "tracking_url": "https://www.sf-international.com/", "status": "cancelled", "tracking_company": "SF International", "updated_at": "2012-05-01T14:22:25-04:00", "line_items": [ { "grams": 100, "price": "23.09", "product_id": "16056761559984840457934011", "fulfillment_status": "fulfilled", "name": "Product name", "quantity": 1, "variant_id": "18056761559987524812644011", "fulfillment_service": "Sf", "variant_title": "big", "title": "Beautiful skirt", "attribute": "red", "vendor": "Supplier", "tax_lines": [ { "price_set": { "shop_money": { "currency_code": "USD", "amount": "3.25" }, "presentment_money": { "amount": "3.25", "currency_code": "USD" } }, "rate": 1, "title": "tax", "price": "3.25" } ], "fulfillable_quantity": 1, "id": "312", "requires_shipping": false, "sku": "18056761559987524812644011", "taxable": true } ], "order_id": "21056577640603870897253153", "created_at": "2012-05-01T14:22:25-04:00" } ] }, "total_outstanding": { "name": "total_outstanding", "description": "Sum of unpaid amount, precision 2", "type": "string", "example": "8.00" }, "phone": { "name": "phone", "description": "Buyer contact information, there must be one of the two", "type": "string", "example": "12903001000" }, "browser_ip": { "name": "browser_ip", "description": "Client IP", "type": "string", "example": "157.119.232.35" } }, "example": { "store_id": "1644828244663", "subtotal_price_set": { "presentment_money": { "currency_code": "USD", "amount": "3.25" }, "shop_money": { "amount": "3.25", "currency_code": "USD" } }, "discount_codes": [ { "amount": "3.25", "code": "KIN4GNAB2FRH", "type": "deduction amount" } ], "payment_gateway_names": [ "PayPal" ], "name": "test1001", "total_discounts": "3.25", "created_at": "2012-05-01T14:22:25-04:00", "browser_ip": "157.119.232.35", "customer": { "currency": "USD", "id": "4201057495", "phone": "19872121232", "updated_at": "2012-05-01T14:22:25-04:00", "first_name": "Tom", "last_name": "Washington", "area_code": "+86", "created_at": "2012-05-01T14:22:25-04:00", "email": "test001@Gmail.com", "addresses": { "name": "Tom Washington ", "province": "California", "province_code": "4300006", "city": "New York", "zip": "52134", "address1": "Address 1", "country_code": "US", "last_name": "Washington", "first_name": "Tom", "phone": "13652133421", "address2": "Address 2", "country": "Usa" } }, "updated_at": "2012-05-01T14:22:25-04:00", "tax_lines": [ { "rate": 1, "title": "tax", "price": "3.25", "price_set": { "presentment_money": { "amount": "USD", "currency_code": "" }, "shop_money": { "amount": "3.25", "currency_code": "USD" } } } ], "total_tax_set": { "shop_money": { "amount": "8.00", "currency_code": "USD" }, "presentment_money": { "amount": "8.00", "currency_code": "USD" } }, "payment_details": [ { "pay_status": "unpaid", "order_seq": "23057287797738260472676128", "processed_at": "2023-04-12T22:59:52+08:00", "pay_amount": 3.25, "pay_channel_deal_id": "pi_3MI897Hezv8FxjBO1uGxMPhX", "status_code": "RISK_PENDING", "status_msg": "PENDING_REVIEW", "pay_seq": "23057287797738260472676128", "create_time": "2012-05-01T14:22:25-04:00" } ], "subtotal_price": "3.25", "id": "21050224312121887324667162", "currency": "USD", "checkout_id": "2404785166526352972864", "credit_limit": { "total_credit_limit": "1.00", "credit_limit_currency": "USD", "is_credit_limit": true, "outstanding_credit_limit": "1.00" }, "tax_number": "111111", "taxes_included": false, "current_total_tax_set": { "presentment_money": { "currency_code": "USD", "amount": "8.00" }, "shop_money": { "currency_code": "USD", "amount": "8.00" } }, "billing_address": { "phone": "13890312312", "zip": "521000", "city": "New York", "country": "Usa", "name": "Tom Washington", "province_code": "4300006", "address1": "Address 1", "company": "new company", "province": "California", "address2": "Address 2", "first_name": "Tom", "country_code": "US", "last_name": "Washington" }, "order_status_url": "https://shoptest.myshoplinestg.com/trade/thank_you?mainOrderMark=xxx&mainOrderSeq=200565776406008509", "note_attributes": [ { "name": "Notes source", "value": "Notes", "create_time": "2012-05-01T14:22:25-04:00" } ], "financial_status": "unpaid", "processed_user_id": "4201057495", "tax_type": "type", "discount_applications": [ { "value": "20", "allocation_method": "across", "description": "Discount description", "target_selection": "explicit", "target_type": "line_item", "title": "Discount title", "type": "manual", "value_type": "fixed_amount", "code": "1Q3UMQM8RBP5" } ], "presentment_currency": "USD", "deduct_member_point_amount": "3.25", "cart_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 Sa" }, "current_total_discounts": "3.25", "current_total_price_set": { "shop_money": { "amount": "8.00", "currency_code": "USD" }, "presentment_money": { "amount": "8.00", "currency_code": "USD" } }, "total_discounts_set": { "shop_money": { "currency_code": "USD", "amount": "3.25" }, "presentment_money": { "currency_code": "USD", "amount": "3.25" } }, "total_tip_received": "8.00", "user_id": "4201057495", "total_weight": 100, "refunds": [ { "user_id": "4201057495", "created_at": "2012-05-01T14:22:25-04:00", "id": "2605659027312156877634", "note": "Refund Notes", "order_id": "21056577640603870897253153", "processed_at": "2012-05-02T14:22:25-04:00", "refund_line_items": [ { "subtotal": 3.25, "total_tax": 0, "id": "2605659027312156877634", "quantity": 2, "line_item_id": "302", "total_tax_set": { "presentment_money": { "currency_code": "USD", "amount": "3.25" }, "shop_money": { "amount": "3.25", "currency_code": "USD" } }, "subtotal_set": { "presentment_money": { "amount": "3.25", "currency_code": "USD" }, "shop_money": { "amount": "3.25", "currency_code": "USD" } }, "line_item": { "price": "3.25", "variant_title": "big", "id": "312", "requires_shipping": true, "title": "Beautiful skirt", "sku": "18056761559987524812644011", "variant_id": "18056761559987524812644011", "name": "test-002", "grams": 100, "attribute": "red", "fulfillment_service": "Sf", "tax_lines": [ { "rate": 1, "title": "tax", "price": "3.25", "price_set": { "presentment_money": { "amount": "3.25", "currency_code": "USD" }, "shop_money": { "amount": "3.25", "currency_code": "USD" } } } ], "product_id": "16056761559984840457934011", "fulfillment_status": "fulfilled", "vendor": "Supplier", "taxable": true, "quantity": 2, "fulfillable_quantity": 2 }, "restock_type": "no_restock" } ], "transactions": [ { "created_at": "2012-05-01T14:22:25-04:00", "id": "2605659027312156877634", "amount": "3.25", "currency": "USD", "status": "pending", "kind": "authorization", "order_id": "21056577640603870897253153", "user_id": "4201057495", "processed_at": "2012-05-01T14:22:25-04:00" } ] } ], "current_total_discounts_set": { "presentment_money": { "amount": "3.25", "currency_code": "USD" }, "shop_money": { "currency_code": "USD", "amount": "3.25" } }, "current_subtotal_price": "78.08", "tags": "Tag", "customer_locale": "enCN", "fulfillment_status": "fulfilled", "line_items": [ { "fulfillment_status": "fulfilled", "id": "417", "vendor": "Supplier", "name": "Product title", "discount_allocations": [ { "amount": "8.00", "amount_set": { "shop_money": { "currency_code": "USD", "amount": "8.00" }, "presentment_money": { "amount": "8.00", "currency_code": "USD" } }, "discount_application_index": 1 } ], "requires_shipping": true, "title": "Nice looking skirt", "price": "3.25", "location_id": "5327026538935748524", "grams": 100, "variant_id": "18056761559987524812644011", "quantity": 2, "properties": [ { "name": "Attribute name", "type": "text", "urls": [ "https://www.url.com" ], "value": "Attribute value", "additional": "Additional field" } ], "taxable": true, "tax_lines": [ { "title": "tax", "type": "shipping_tax", "price": "3.25", "price_set": { "presentment_money": { "currency_code": "USD", "amount": "3.25" }, "shop_money": { "currency_code": "USD", "amount": "3.25" } }, "rate": 1 } ], "variant_title": "big", "fulfillment_service": "Sf", "product_id": "16056761559984840457934011", "tags": "Tag 1 , cute", "attribute": "red", "fulfillable_quantity": 1, "sku": "18056761559987524812644011" } ], "cancel_reason": "\" don ' t want to buy \"", "phone": "12903001000", "cancelled_at": "2012-05-01T14:22:25-04:00", "total_outstanding": "8.00", "shipping_lines": [ { "price": "8.00", "shipping_price": "8.00", "title": "SF International", "discount_allocations": [ { "amount": "8.00", "amount_set": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "currency_code": "USD", "amount": "8.00" } }, "discount_application_index": 1 } ], "discounted_price": "8.00", "discounted_price_set": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "currency_code": "USD", "amount": "8.00" } }, "price_set": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } }, "phone": "13243214565", "source": "source", "code": "SF", "requested_fulfillment_service_id": "LX88888", "tax_lines": [ { "price_set": { "shop_money": { "amount": "8.00", "currency_code": "USD" }, "presentment_money": { "amount": "8.00", "currency_code": "USD" } }, "rate": 1, "title": "tax", "price": "8.00" } ] } ], "processed_at": "2023-04-12T22:59:52+08:00", "email": "test1002@Gmail.com", "total_tax": "8.00", "total_shipping_price_set": { "shop_money": { "currency_code": "USD", "amount": "8.00" }, "presentment_money": { "amount": "8.00", "currency_code": "USD" } }, "note": "Notes", "current_subtotal_price_set": { "presentment_money": { "currency_code": "USD", "amount": "78.08" }, "shop_money": { "currency_code": "USD", "amount": "78.08" } }, "fulfillments": [ { "line_items": [ { "taxable": true, "grams": 100, "fulfillment_status": "fulfilled", "name": "Product name", "title": "Beautiful skirt", "vendor": "Supplier", "quantity": 1, "sku": "18056761559987524812644011", "tax_lines": [ { "price_set": { "presentment_money": { "currency_code": "USD", "amount": "3.25" }, "shop_money": { "amount": "3.25", "currency_code": "USD" } }, "rate": 1, "title": "tax", "price": "3.25" } ], "id": "312", "fulfillment_service": "Sf", "requires_shipping": false, "attribute": "red", "variant_id": "18056761559987524812644011", "variant_title": "big", "price": "23.09", "product_id": "16056761559984840457934011", "fulfillable_quantity": 1 } ], "tracking_number": "yun0001", "tracking_url": "https://www.sf-international.com/", "name": "1032-F2", "updated_at": "2012-05-01T14:22:25-04:00", "id": "22046737798141702810214336", "shipment_status": "fulfilled", "order_id": "21056577640603870897253153", "status": "cancelled", "tracking_company": "SF International", "created_at": "2012-05-01T14:22:25-04:00" } ], "current_total_tax": "8.00", "app_id": "222222", "total_line_items_price_set": { "presentment_money": { "currency_code": "USD", "amount": "8.00" }, "shop_money": { "currency_code": "USD", "amount": "8.00" } }, "current_total_price": "8.00", "shipping_address": { "first_name": "Tom", "zip": "92503", "address2": "Address 2", "last_name": "Washington", "city": "New York", "longitude": "41", "province": "California", "country_code": "US", "province_code": "4200006", "country": "Usa", "address1": "Address 1", "company": "New company name", "latitude": "15", "phone": "1320987655", "name": "Tom Washington" }, "total_line_items_price": "8.00", "checkout_token": "c2c4a58186b9d96395d7e6b5c2969577" } }, "user_errors": { "name": "user_errors", "description": "Error prompt information in this execution , if the implementation result is wrong , this field will return error information", "type": "array", "items": { "name": "user_errors", "description": "Error prompt information in this execution , if the implementation result is wrong , this field will return error information", "type": "object", "properties": { "code": { "name": "code", "description": "Wrong code", "type": "string", "example": "illegal param" }, "field": { "name": "field", "description": "Path that causes incorrect input fields", "type": "array", "items": { "name": "field", "description": "Path that causes incorrect input fields", "type": "string", "example": "" }, "example": [ "" ] }, "message": { "name": "message", "description": "Error message", "type": "string", "example": "" } }, "example": { "code": "illegal param", "field": [ "" ], "message": "" } }, "example": [ { "code": "illegal param", "field": [ "" ], "message": "" } ] } }, "example": { "order": { "current_total_discounts_set": { "presentment_money": { "amount": "3.25", "currency_code": "USD" }, "shop_money": { "amount": "3.25", "currency_code": "USD" } }, "presentment_currency": "USD", "shipping_lines": [ { "tax_lines": [ { "price_set": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } }, "rate": 1, "title": "tax", "price": "8.00" } ], "price_set": { "presentment_money": { "currency_code": "USD", "amount": "8.00" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } }, "source": "source", "discount_allocations": [ { "amount_set": { "presentment_money": { "currency_code": "USD", "amount": "8.00" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } }, "discount_application_index": 1, "amount": "8.00" } ], "discounted_price_set": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } }, "phone": "13243214565", "discounted_price": "8.00", "price": "8.00", "requested_fulfillment_service_id": "LX88888", "title": "SF International", "code": "SF", "shipping_price": "8.00" } ], "tags": "Tag", "current_subtotal_price": "78.08", "payment_gateway_names": [ "PayPal" ], "current_total_tax": "8.00", "credit_limit": { "total_credit_limit": "1.00", "credit_limit_currency": "USD", "is_credit_limit": true, "outstanding_credit_limit": "1.00" }, "current_total_discounts": "3.25", "refunds": [ { "order_id": "21056577640603870897253153", "processed_at": "2012-05-02T14:22:25-04:00", "refund_line_items": [ { "line_item_id": "302", "quantity": 2, "total_tax_set": { "presentment_money": { "amount": "3.25", "currency_code": "USD" }, "shop_money": { "amount": "3.25", "currency_code": "USD" } }, "restock_type": "no_restock", "total_tax": 0, "line_item": { "vendor": "Supplier", "title": "Beautiful skirt", "id": "312", "fulfillment_service": "Sf", "sku": "18056761559987524812644011", "fulfillable_quantity": 2, "product_id": "16056761559984840457934011", "price": "3.25", "taxable": true, "requires_shipping": true, "fulfillment_status": "fulfilled", "quantity": 2, "tax_lines": [ { "price": "3.25", "price_set": { "shop_money": { "amount": "3.25", "currency_code": "USD" }, "presentment_money": { "amount": "3.25", "currency_code": "USD" } }, "rate": 1, "title": "tax" } ], "variant_title": "big", "variant_id": "18056761559987524812644011", "name": "test-002", "grams": 100, "attribute": "red" }, "subtotal_set": { "shop_money": { "amount": "3.25", "currency_code": "USD" }, "presentment_money": { "amount": "3.25", "currency_code": "USD" } }, "id": "2605659027312156877634", "subtotal": 3.25 } ], "transactions": [ { "kind": "authorization", "processed_at": "2012-05-01T14:22:25-04:00", "status": "pending", "user_id": "4201057495", "amount": "3.25", "currency": "USD", "order_id": "21056577640603870897253153", "created_at": "2012-05-01T14:22:25-04:00", "id": "2605659027312156877634" } ], "user_id": "4201057495", "created_at": "2012-05-01T14:22:25-04:00", "id": "2605659027312156877634", "note": "Refund Notes" } ], "line_items": [ { "product_id": "16056761559984840457934011", "sku": "18056761559987524812644011", "title": "Nice looking skirt", "requires_shipping": true, "variant_title": "big", "id": "417", "discount_allocations": [ { "amount": "8.00", "amount_set": { "shop_money": { "amount": "8.00", "currency_code": "USD" }, "presentment_money": { "amount": "8.00", "currency_code": "USD" } }, "discount_application_index": 1 } ], "tax_lines": [ { "title": "tax", "type": "shipping_tax", "price": "3.25", "price_set": { "shop_money": { "amount": "3.25", "currency_code": "USD" }, "presentment_money": { "amount": "3.25", "currency_code": "USD" } }, "rate": 1 } ], "location_id": "5327026538935748524", "properties": [ { "urls": [ "https://www.url.com" ], "value": "Attribute value", "additional": "Additional field", "name": "Attribute name", "type": "text" } ], "quantity": 2, "grams": 100, "variant_id": "18056761559987524812644011", "fulfillment_service": "Sf", "attribute": "red", "tags": "Tag 1 , cute", "vendor": "Supplier", "name": "Product title", "fulfillable_quantity": 1, "price": "3.25", "fulfillment_status": "fulfilled", "taxable": true } ], "name": "test1001", "shipping_address": { "zip": "92503", "city": "New York", "name": "Tom Washington", "phone": "1320987655", "province": "California", "country_code": "US", "latitude": "15", "address2": "Address 2", "province_code": "4200006", "country": "Usa", "last_name": "Washington", "first_name": "Tom", "longitude": "41", "company": "New company name", "address1": "Address 1" }, "current_total_price": "8.00", "total_discounts_set": { "presentment_money": { "currency_code": "USD", "amount": "3.25" }, "shop_money": { "amount": "3.25", "currency_code": "USD" } }, "processed_user_id": "4201057495", "note": "Notes", "app_id": "222222", "total_shipping_price_set": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } }, "tax_number": "111111", "total_tax_set": { "shop_money": { "amount": "8.00", "currency_code": "USD" }, "presentment_money": { "amount": "8.00", "currency_code": "USD" } }, "fulfillments": [ { "shipment_status": "fulfilled", "id": "22046737798141702810214336", "tracking_company": "SF International", "order_id": "21056577640603870897253153", "tracking_number": "yun0001", "tracking_url": "https://www.sf-international.com/", "line_items": [ { "title": "Beautiful skirt", "fulfillment_status": "fulfilled", "variant_id": "18056761559987524812644011", "fulfillment_service": "Sf", "taxable": true, "name": "Product name", "vendor": "Supplier", "price": "23.09", "quantity": 1, "sku": "18056761559987524812644011", "id": "312", "requires_shipping": false, "tax_lines": [ { "price": "3.25", "price_set": { "shop_money": { "amount": "3.25", "currency_code": "USD" }, "presentment_money": { "currency_code": "USD", "amount": "3.25" } }, "rate": 1, "title": "tax" } ], "variant_title": "big", "grams": 100, "product_id": "16056761559984840457934011", "attribute": "red", "fulfillable_quantity": 1 } ], "created_at": "2012-05-01T14:22:25-04:00", "name": "1032-F2", "updated_at": "2012-05-01T14:22:25-04:00", "status": "cancelled" } ], "total_line_items_price_set": { "shop_money": { "amount": "8.00", "currency_code": "USD" }, "presentment_money": { "amount": "8.00", "currency_code": "USD" } }, "checkout_token": "c2c4a58186b9d96395d7e6b5c2969577", "updated_at": "2012-05-01T14:22:25-04:00", "cart_token": "c2c4a58186b9d96395d7e6b5c2969577", "user_id": "4201057495", "tax_lines": [ { "title": "tax", "price": "3.25", "price_set": { "presentment_money": { "amount": "USD", "currency_code": "" }, "shop_money": { "amount": "3.25", "currency_code": "USD" } }, "rate": 1 } ], "taxes_included": false, "current_subtotal_price_set": { "presentment_money": { "amount": "78.08", "currency_code": "USD" }, "shop_money": { "currency_code": "USD", "amount": "78.08" } }, "checkout_id": "2404785166526352972864", "total_tip_received": "8.00", "phone": "12903001000", "order_status_url": "https://shoptest.myshoplinestg.com/trade/thank_you?mainOrderMark=xxx&mainOrderSeq=200565776406008509", "cancelled_at": "2012-05-01T14:22:25-04:00", "customer": { "first_name": "Tom", "updated_at": "2012-05-01T14:22:25-04:00", "id": "4201057495", "email": "test001@Gmail.com", "last_name": "Washington", "phone": "19872121232", "currency": "USD", "area_code": "+86", "created_at": "2012-05-01T14:22:25-04:00", "addresses": { "country": "Usa", "country_code": "US", "phone": "13652133421", "province": "California", "zip": "52134", "name": "Tom Washington ", "address2": "Address 2", "city": "New York", "last_name": "Washington", "province_code": "4300006", "address1": "Address 1", "first_name": "Tom" } }, "email": "test1002@Gmail.com", "currency": "USD", "cancel_reason": "\" don ' t want to buy \"", "financial_status": "unpaid", "customer_locale": "enCN", "current_total_tax_set": { "presentment_money": { "amount": "8.00", "currency_code": "USD" }, "shop_money": { "amount": "8.00", "currency_code": "USD" } }, "current_total_price_set": { "shop_money": { "amount": "8.00", "currency_code": "USD" }, "presentment_money": { "amount": "8.00", "currency_code": "USD" } }, "discount_codes": [ { "amount": "3.25", "code": "KIN4GNAB2FRH", "type": "deduction amount" } ], "fulfillment_status": "fulfilled", "created_at": "2012-05-01T14:22:25-04:00", "id": "21050224312121887324667162", "processed_at": "2023-04-12T22:59:52+08:00", "tax_type": "type", "browser_ip": "157.119.232.35", "note_attributes": [ { "create_time": "2012-05-01T14:22:25-04:00", "name": "Notes source", "value": "Notes" } ], "total_weight": 100, "store_id": "1644828244663", "total_line_items_price": "8.00", "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 Sa" }, "discount_applications": [ { "title": "Discount title", "value_type": "fixed_amount", "code": "1Q3UMQM8RBP5", "target_selection": "explicit", "target_type": "line_item", "description": "Discount description", "type": "manual", "allocation_method": "across", "value": "20" } ], "subtotal_price_set": { "presentment_money": { "currency_code": "USD", "amount": "3.25" }, "shop_money": { "amount": "3.25", "currency_code": "USD" } }, "total_outstanding": "8.00", "total_tax": "8.00", "deduct_member_point_amount": "3.25", "subtotal_price": "3.25", "total_discounts": "3.25", "payment_details": [ { "status_msg": "PENDING_REVIEW", "pay_amount": 3.25, "pay_status": "unpaid", "status_code": "RISK_PENDING", "create_time": "2012-05-01T14:22:25-04:00", "order_seq": "23057287797738260472676128", "pay_channel_deal_id": "pi_3MI897Hezv8FxjBO1uGxMPhX", "processed_at": "2023-04-12T22:59:52+08:00", "pay_seq": "23057287797738260472676128" } ], "billing_address": { "last_name": "Washington", "country": "Usa", "phone": "13890312312", "province": "California", "province_code": "4300006", "first_name": "Tom", "city": "New York", "country_code": "US", "address2": "Address 2", "company": "new company", "name": "Tom Washington", "zip": "521000", "address1": "Address 1" } }, "user_errors": [ { "code": "illegal param", "field": [ "" ], "message": "" } ] } } } } }, "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": "post", "path": "/orders/order_edit_commit.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": "Submit edit results", "version": "v20270301" }, "authIndexes": [ "write_orders" ] } ```