Update order

Requires write_orders access scope.

For more info , refer to:

[]

access permission

PUT https://{handle}.myshopline.com/admin/openapi/v20250601/orders/:id.json

[]

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 .

[]

Update Order

Path Parameters

id string required
[]
Order number
[]
Example: "21050342939778451436179579"

Request Headers

Content-Type required
[]
The value of this field is fixed to application/json; charset=utf-8
Authorization string required
[]
The access token for the API. Please refer to App authorization to obtain the access token, and then put the obtained access token into the API request header in Bearer Token.
Example:
[]
Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

Request Body

orderobject
[]
Order object
area_code string
[]
Customer's phone number area code
[]
Example: 86
customer_id string
[]
Customer ID
[]
Example: 3100314101
email string
[]
Customer's email
[]
Example: sdaw@gmail.com
id string
[]
Order number
[]
Example: 1001
line_itemsobject[]
[]
Xuyao Product needs to be updated
id string
[]
Order Product id
[]
Example: 14865639
tags string
[]
Product tag , multiple divided by english comma to cover existing tag
[]
Example: tag1,tag2
note_attributesobject[]
[]
Additional information
name string
[]
Note source ( merchant logo )
[]
Example: Note source
value string
[]
Notes
[]
Example: Notes
phone string
[]
Customer's phone number
[]
Example: 18819402211
shipping_addressobject
[]
Shipping address
address1 string
[]
Detailed shipping address (maximum 255 characters)
[]
Example: Address 1
address2 string
[]
Additional details of shipping address (maximum 255 characters)
[]
Example: Address 2
area string
[]
District/County name of shipping address (maximum 64 characters)
[]
Example: Area
area_code string
[]
District/County code of shipping address
[]
Example: 210002
city string
[]
City name of shipping address (maximum 64 characters)
[]
Example: New York
city_code string
[]
City code of shipping address
[]
Example: 210003
company string
[]
Company name
[]
Example: google
country string
[]
Country name of shipping address (maximum 64 characters)
[]
Example: united states
country_code string
[]
Country or region, please refer to country codes
[]
Example: US
email string
[]
Shipping contact email
[]
Example: sdaw@gmail.com
first_name string
[]
Shipping contact name (maximum 64 characters)
[]
Example: Lebron
last_name string
[]
Shipping contact last name (maximum 64 characters)
[]
Example: James
latitude string
[]
Latitude
[]
Example: 33.111232
longitude string
[]
Longitude
[]
Example: 11.22323
phone string
[]
Shipping contact phone number (maximum 32 characters)
[]
Example: 18819402211
province string
[]
State/Province of shipping address (maximum 64 characters)

State/Province of shipping address (maximum 64 characters)
[]
Example: California
province_code string
[]
State/Province code of shipping address, custom code or two-letter abbreviation (ISO-3166-2)
[]
Example: 212221
zip string
[]
Zip/Postal code
[]
Example: 123551
tags string
[]
Order tag , multiple divided by english comma to cover existing tag
[]
Example: xternal, Inbound, Outbound

Response

[]

For more information about status codes, see Http status code.

Response Headers

traceId
[]
traceId

Response Body

orderobject
[]
For order information, field descriptions and examples, please refer to the response result of the order list
app_id string
[]
App ID
[]
Example: 222222
billing_addressobject
[]
billing address
address1 string
[]
Detailed address of bill recipient (maximum 255 characters)
[]
Example: Address 1
address2 string
[]
Billing recipient address details appended (maximum 255 characters)
[]
Example: Address 2
city string
[]
Bill recipient city (maximum 64 characters)
[]
Example: New York
company string
[]
Company Name
[]
Example: new company
country string
[]
Billing recipient country (maximum 64 characters)
[]
Example: USA
country_code string
[]
Bill recipient country code
[]
Example: US
first_name string
[]
Bill recipient name
[]
Example: Tom
last_name string
[]
Bill Recipient Last Name
[]
Example: Washington
name string
[]
Billing name
[]
Example: Tom Washington
phone string
[]
Bill recipient’s name and mobile phone number
[]
Example: 13890312312
province string
[]
Bill recipient name province
[]
Example: California
province_code string
[]
Bill recipient name, province code
[]
Example: 4300006
zip string
[]
Bill recipient name zip code
[]
Example: 521000
browser_ip string
[]
Client IP
[]
Example: 157.119.232.35
cancel_reason string
[]
Seller's reason for cancellation
[]
Example: " don ' t want to buy "
cancelled_at string
[]
Order cancellation time (end) (see IOS8601 for the format), 2012-05-01T14:22:25-04:00
[]
Example: 2012-05-01T14:22:25-04:00
cart_token string
[]
shopping cart token
[]
Example: c2c4a58186b9d96395d7e6b5c2969577
checkout_id string
[]
abandoned order id
[]
Example: 2404785166526352972864
checkout_token string
[]
Checkout page token
[]
Example: c2c4a58186b9d96395d7e6b5c2969577
client_detailsobject
[]
Client Details
browser_ip string
[]
Client ip address
[]
Example: 157.119.232.35
session_hash string
[]
Member session encryption information
[]
Example: c2c4a58186b9d96395d7e6b5c2969577
user_agent string
[]
Client Proxy
[]
Example: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/106.0.0.0 Sa
companyobject
[]
Company info
id string
[]
Company id
[]
Example: 1005619945158043247856
location_id string
[]
Location id
[]
Example: 3005619945158043247856
tax_registration_id string
[]
Tax registration id
[]
Example: 213213
created_at string
[]
Order creation time (see IOS8601 for the format)
[]
Example: 2012-05-01T14:22:25-04:00
credit_limitobject
[]
credit payment
credit_limit_currency string
[]
Currency of the credit limit, currently in store currency
[]
Example: USD
is_credit_limit boolean
[]
Whether the order used credit payment true: Used false: Not used
[]
Example: true
outstanding_credit_limit string
[]
Total credit limit occupied by the order
[]
Example: 1.00
total_credit_limit string
[]
Total credit limit used for the order
[]
Example: 1.00
currency string
[]
Transaction currency
[]
Example: USD
current_subtotal_price string
[]
Sum of current products, total price of products * quantity
[]
Example: 78.08
current_subtotal_price_setobject
[]
Multi-currency information of the current commodity sum, the buyer's and seller's currency and the amount are the same
presentment_moneyobject
[]
Buy side currency
amount string
[]
Amount
[]
Example: 78.08
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side amount
amount string
[]
Amount, Precision 2
[]
Example: 78.08
currency_code string
[]
Currency code
[]
Example: USD
current_total_discounts string
[]
Sum of discounts, precision 2, marketing offers + artificial discounts
[]
Example: 3.25
current_total_discounts_setobject
presentment_moneyobject
[]
Currency information
amount string
[]
Amount
[]
Example: 3.25
currency_code string
[]
Currency information
[]
Example: USD
shop_moneyobject
[]
Sell side amount
amount string
[]
Amount
[]
Example: 3.25
currency_code string
[]
Currency
[]
Example: USD
current_total_duties_setobject
[]
Current Product total duty
presentment_moneyobject
[]
Buyer side amount information
amount string
[]
Amount
[]
Example: 8.88
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side amount information
amount string
[]
Amount
[]
Example: 8.88
currency_code string
[]
Currency
[]
Example: USD
current_total_price string
[]
Total tax, product tax + shipping tax
[]
Example: 8.00
current_total_price_setobject
[]
Multi-currency information of the sum of taxes, the currency and amount of buyers and sellers are the same
presentment_moneyobject
[]
Buy side currency
amount string
[]
Amount
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side currency
amount string
[]
Amount
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
current_total_tax string
[]
Total tax, product tax + shipping tax
[]
Example: 8.00
current_total_tax_setobject
[]
Multi-currency information of the sum of taxes, the currency and amount of buyers and sellers are the same
presentment_moneyobject
[]
Buy side currency
amount string
[]
Amount
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side currency
amount string
[]
Amount
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
customerobject
[]
Buyer information
addressesobject
[]
Buyer address information
address1 string
[]
Detailed address 1
[]
Example: Address 1
address2 string
[]
Detailed address 2, optional
[]
Example: Address 2
city string
[]
City
[]
Example: New York
country string
[]
Country
[]
Example: USA
country_code string
[]
Country code
[]
Example: US
first_name string
[]
Last name
[]
Example: Tom
last_name string
[]
First name
[]
Example: Washington
name string
[]
Full name
[]
Example: Tom Washington
phone string
[]
Phone
[]
Example: 13652133421
province string
[]
Province
[]
Example: California
province_code string
[]
Province code
[]
Example: 4300006
zip string
[]
Postal code
[]
Example: 52134
area_code string
[]
Phone area code
[]
Example: +86
created_at string
[]
Buyer creation time (see IOS8601 for the format)
[]
Example: 2012-05-01T14:22:25-04:00
currency string
[]
Currency
[]
Example: USD
email string
[]
User mailbox
[]
Example: test001@Gmail.com
first_name string
[]
First name
[]
Example: Tom
id string
[]
User ID
[]
Example: 4201057495
last_name string
[]
Last name
[]
Example: Washington
phone string
[]
User mobile phone number
[]
Example: 19872121232
updated_at string
[]
Buyer update time
[]
Example: 2012-05-01T14:22:25-04:00
customer_locale string
[]
Buyer country, language code + country name abbreviation
[]
Example: enCN
deduct_member_point_amount string
[]
Current order membership credit
[]
Example: 3.25
deduct_member_point_amount_setobject
[]
Current order membership credit to the amount , multi-currency information
presentment_moneyobject
[]
Buy side currency
amount string
[]
Amount
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side currency
amount string
[]
Amount
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
discount_applicationsobject[]
[]
discount information
allocation_method string
[]
1 ) across ( the value is distributed in all authorized lines ) 2 ) the ach ( the value is applied to each authorized line )
[]
Example: across
code string
[]
discount code
[]
Example: 1Q3UMQM8RBP5
description string
[]
Custom discount description
[]
Example: Discount description
target_selection string
[]

explicit (discount is assigned to explicitly selected rows) 2) all (discount is assigned to all rows) 3) ENTITLED (discount is assigned only to rows for which it has permission)

[]
Example: explicit
target_type string
[]

line_item, shipping_line

[]
Example: line_item
title string
[]
Automatic discount title
[]
Example: Discount title
type string
[]
Discount type
[]
Example: manual
value string
[]
The specific value of the discount (can be N discounts or a specific amount)
[]
Example: 20
value_type string
[]
% discount , amount discount
[]
Example: fixed_amount
discount_codesobject[]
[]
Promo code information
amount string
[]
Discount amount, precision 2
[]
Example: 3.25
amount_setobject
[]
Discount amount , multi-currency information
presentment_moneyobject
[]
Buy side currency
amount string
[]
Amount
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side currency
amount string
[]
Amount
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
code string
[]
Promo code
[]
Example: KIN4GNAB2FRH
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;
[]
Example: Reduction amount
email string
[]
Buyer's mailbox, there must be one of the two
[]
Example: test1002@Gmail.com
financial_status string
[]
Payment status, unpaid, authorized, pending, partially_paid, paid, partially_refunded, refunded
[]
Example: unpaid
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
[]
Example: fulfilled
fulfillmentsobject[]
[]
Package information
created_at string
[]
Creation time (see IOS8601 for the format)
[]
Example: 2012-05-01T14:22:25-04:00
id string
[]
Package number
[]
Example: 22046737798141702810214336
line_itemsobject[]
[]
Product list
attribute string
[]
Product attributes : name-attribute value multiple comma " , " division like : color-red , size-x
[]
Example: red
fulfillable_quantity integer
[]
Available quantity
[]
Example: 1
fulfillment_service string
[]
Logistics company name
[]
Example: SF Express
fulfillment_status string
[]
The shipping status of the product, shipping status, fulfilled-shipped; partial-partially shipped; null-unshipped;
[]
Example: fulfilled
grams double
[]
Weight ( grams )
[]
Example: 100
id string
[]
The ID of the product snapshot table, generated by the system, uniquely confirms a product with the order number
[]
Example: 312
name string
[]
SKU title, same as title
[]
Example: Product name
price string
[]
Commodity price, precision 2
[]
Example: 23.09
price_setobject
[]
Product selling price , multi-currency information
presentment_moneyobject
[]
Buy side currency
amount string
[]
Amount
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side currency
amount string
[]
Amount
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
product_id string
[]
SPU serial number
[]
Example: 16056761559984840457934011
quantity integer
[]
Quantity of items in the order
[]
Example: 1
requires_shipping boolean
[]
Shipping or not
sku string
[]
Product code, barCode
[]
Example: 18056761559987524812644011
tax_linesobject[]
[]
Tax information
price string
[]
Tax, precision 2
[]
Example: 3.25
price_setobject
[]
Multi-currency information of tax
presentment_moneyobject
[]
Currency information
amount string
[]
Amount
[]
Example: 3.25
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side amount information
amount string
[]
Amount
[]
Example: 3.25
currency_code string
[]
Currency
[]
Example: USD
rate double
[]
Tax rate
[]
Example: 1
title string
[]
Tax name
[]
Example: taxes
taxable boolean
[]
Tax or not？
[]
Example: true
title string
[]
Product title
[]
Example: beautiful skirt
variant_id string
[]
Product SKU serial number
[]
Example: 18056761559987524812644011
variant_title string
[]
Commodity attribute value, multiple divided by " / ", such as: "155 / red / large"
[]
Example: big
vendor string
[]
Supplier
[]
Example: Supplier
name string
[]
Invoice short number
[]
Example: 1032-F2
order_id string
[]
Order number
[]
Example: 21056577640603870897253153
shipment_status string
[]
Package tracking
[]
Example: fulfilled
status string
[]
Logistics delivery status, success-shipped; cancelled-cancelled;
[]
Example: cancelled
tracking_company string
[]
Logistics company name
[]
Example: SF International
tracking_number string
[]
Third party tracking number
[]
Example: yun0001
tracking_url string
[]
Logistics company URL
[]
Example: https://www.sf-international.com/
updated_at string
[]
Update time (see IOS8601 for the format)
[]
Example: 2012-05-01T14:22:25-04:00
id string
[]
Order number, system-defined number
[]
Example: 21050224312121887324667162
line_itemsobject[]
[]
Order product snapshot information
attribute string
[]
Product attributes : name-attribute value multiple comma " , " division like : color-red , size-x
[]
Example: red
country_code_of_origin string
[]
Country of origin
[]
Example: Country of origin
discount_allocationsobject[]
[]
Marketing discount details in multiple currencies
amount string
[]
Discount details
[]
Example: 8.00
amount_setobject
[]
Discount details in multiple currencies
presentment_moneyobject
[]
Payment currency
amount string
[]
Amount, Precision 2
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Store currency
amount string
[]
Amount, Precision 2
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
discount_application_index integer
[]
Indicate the position in the discount details
[]
Example: 1
dutiesobject[]
[]
Duty information
country_code_of_origin string
[]
Country code of origin/shipping point
[]
Example: US
harmonized_system_code string
[]
Customs code
[]
Example: 111
id string
[]
Tariff number
[]
Example: 12345
priceobject
[]
Tariff multi-currency information
presentment_moneyobject
[]
Buyer side amount information
amount string
[]
Amount
[]
Example: 8.88
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side amount information
amount string
[]
Amount
[]
Example: 8.88
currency_code string
[]
Currency
[]
Example: USD
tax_linesobject[]
[]
Tax details list
price_setobject
[]
Multi-currency information of tax
presentment_moneyobject
[]
Buyer side amount information
amount string
[]
Amount
[]
Example: 8.88
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side amount information
amount string
[]
Amount
[]
Example: 8.88
currency_code string
[]
Currency
[]
Example: USD
rate double
[]
Tax rate
[]
Example: 1
rate_percentage double
[]
Tax rate (percentage value, i.e. rate * 100)
[]
Example: 100
title string
[]
Tax title
[]
Example: tax1
fulfillable_quantity integer
[]
Available quantity
[]
Example: 1
fulfillment_service string
[]
Logistics company name
[]
Example: SF Express
fulfillment_status string
[]
The shipping status of the product, shipping status, fulfilled-shipped; partial-partially shipped; null-unshipped;
[]
Example: fulfilled
grams double
[]
Weight ( grams )
[]
Example: 100
harmonized_system_code string
[]
harmonized system code
[]
Example: harmonized system code
id string
[]
The ID of the product snapshot table, generated by the system, uniquely confirms a product with the order number
[]
Example: 417
location_id string
[]
The corresponding location of the store in the POS scenario
[]
Example: 5327026538935748524
name string
[]
SKU title, same as title
[]
Example: Product title
price string
[]
Commodity price, precision 2
[]
Example: 3.25
price_setobject
[]
Product selling price , multi-currency information
presentment_moneyobject
[]
Buy side currency
amount string
[]
Amount
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side currency
amount string
[]
Amount
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
product_id string
[]
SPU serial number
[]
Example: 16056761559984840457934011
propertiesobject[]
[]
Product customization information
additional string
[]
Customized product additional fields
[]
Example: Additional fields
name string
[]
Custom attribute name
[]
Example: 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
[]
Example: text
urls array
[]
URL resource list
[]
Example: https://www.url.com
value string
[]
Custom attribute values
[]
Example: attribute value
quantity integer
[]
Quantity of items in the order
[]
Example: 2
requires_shipping boolean
[]
Shipping or not
[]
Example: true
sku string
[]
Product code, barCode
[]
Example: 18056761559987524812644011
tags string
[]
Product tags (multiple commas separated)
[]
Example: Tag 1 , cute
tax_linesobject[]
[]
Tax information
price string
[]
Tax, precision 2
[]
Example: 3.25
price_setobject
[]
Multi-currency information of tax
presentment_moneyobject
[]
Buy side currency
amount string
[]
Amount
[]
Example: 3.25
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side currency
amount string
[]
Amount
[]
Example: 3.25
currency_code string
[]
Currency
[]
Example: USD
rate double
[]
Tax rate
[]
Example: 1
title string
[]
Tax name
[]
Example: taxes
type string
[]
Tax fee type, used to distinguish between commodity tax and freight tax. The enumeration value is as follows product_tax: commodity tax shipping_tax: freight tax
[]
Example: shipping_tax
taxable boolean
[]
Tax or not？
[]
Example: true
title string
[]
Product title
[]
Example: Nice looking skirt
variant_id string
[]
Product SKU serial number
[]
Example: 18056761559987524812644011
variant_title string
[]
Commodity attribute value, multiple divided by " / ", such as: "155 / red / large"
[]
Example: big
vendor string
[]
Supplier
[]
Example: Supplier
locationsobject[]
[]
Order location information
location_id string
[]
Location ID
[]
Example: 5327026538935748524
name string
[]
Place name
[]
Example: us.street
type string
[]
Location type. 1.posLocation: The store location where the order was created through the POS channel (it is recommended to use posLocationId, which will be abandoned later) 2.pickupLocation: When the delivery method of the order is self-pickup, the store location for self-pickup 3.productLocation: The inventory location of the goods in the order (It is recommended to use the location information in the product line, which will be abandoned later)
[]
Example: posLocation
name string
[]
Custom order number
[]
Example: test1001
note string
[]
Merchant notes
[]
Example: Notes
note_attributesobject[]
[]
Merchant note log, date content
create_time string
[]
Remark creation time (see IOS8601 for the format)
[]
Example: 2012-05-01T14:22:25-04:00
name string
[]
Remark source (seller ID)
[]
Example: Note source
value string
[]
Notes
[]
Example: Notes
order_source string
[]
Order source channels
[]
Example: pos
order_status_url string
[]
Order status page URL
[]
Example: https://shoptest.myshoplinestg.com/trade/thank_you?mainOrderMark=xxx&mainOrderSeq=200565776406008509
payment_detailsobject[]
[]
Payment slip information
create_time string
[]
Payment slip creation time
[]
Example: 2012-05-01T14:22:25-04:00
order_seq string
[]
Order number
[]
Example: 23057287797738260472676128
pay_amount double
[]
Payment amount
[]
Example: 3.25
pay_channel_deal_id string
[]
External channel payment serial number
[]
Example: pi_3MI897Hezv8FxjBO1uGxMPhX
pay_seq string
[]
Payment slip number
[]
Example: 23057287797738260472676128
pay_status string
[]
Payment order status, unpaid-unpaid; pending-paying; risking-risk control; paid-paid; paid_overtime-payment failed; paid_failed-payment failed;
[]
Example: unpaid
processed_at string
[]
Payment creation time, format: 2023-04-12T22:59:52+08:00
[]
Example: 2023-04-12T22:59:52+08:00
status_code string
[]
Payment status code
[]
Example: RISK_PENDING
status_msg string
[]
Payment order status code description
[]
Example: PENDING_REVIEW
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
[]
Example: PayPal
phone string
[]
Buyer contact information, there must be one of the two
[]
Example: 12903001000
po_number string
[]
Purchase order number recorded on the order in B2B scenarios
pos_location_id string
[]
Pos transaction location
[]
Example: 5327026538935748524
presentment_currency string
[]
Buy side currency, same as sell side currency
[]
Example: USD
processed_at string
[]
Processed_at time , format : 2023-04-12T22 : 59 : 52+08 : 00
[]
Example: 2023-04-12T22:59:52+08:00
processed_user_id string
[]
Order creator
[]
Example: 4201057495
refundsobject[]
[]
Refund list
created_at string
[]
Refund form creation time (see IOS8601 for the format)
[]
Example: 2012-05-01T14:22:25-04:00
id string
[]
Refund ID
[]
Example: 2605659027312156877634
note string
[]
Refund Notes
[]
Example: Refund Notes
order_id string
[]
Order number
[]
Example: 21056577640603870897253153
processed_at string
[]
Update time (see IOS8601 for the format)
[]
Example: 2012-05-02T14:22:25-04:00
refund_line_itemsobject[]
[]
Refund Details
id string
[]
Order number for this adjustment of the single link
[]
Example: 2605659027312156877634
line_itemobject
[]
Refund Product line
attribute string
[]
Product attributes : name-attribute value multiple comma " , " division like : color-red , size-x
[]
Example: red
fulfillable_quantity integer
[]
Available quantity
[]
Example: 2
fulfillment_service string
[]
Logistics company name
[]
Example: SF Express
fulfillment_status string
[]
The shipping status of the product, shipping status, fulfilled-shipped; partial-partially shipped; null-unshipped;
[]
Example: fulfilled
grams double
[]
Weight ( grams )
[]
Example: 100
id string
[]
The ID of the product snapshot table, generated by the system, uniquely confirms a product with the order number
[]
Example: 312
name string
[]
SKU title, same as title
[]
Example: test-002
price string
[]
Commodity price, precision 2
[]
Example: 3.25
price_setobject
[]
Product selling price , multi-currency information
presentment_moneyobject
[]
Buy side currency
amount string
[]
Amount
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side currency
amount string
[]
Amount
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
product_id string
[]
SPU serial number
[]
Example: 16056761559984840457934011
quantity integer
[]
Quantity of items in the order
[]
Example: 2
requires_shipping boolean
[]
Shipping or not
[]
Example: true
sku string
[]
Product code, barCode
[]
Example: 18056761559987524812644011
tax_linesobject[]
[]
Tax information
price string
[]
Tax, precision 2
[]
Example: 3.25
price_setobject
[]
Multi-currency information of tax
presentment_moneyobject
[]
Buy side currency
amount string
[]
Amount, Precision 2
[]
Example: 3.25
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side amount information
amount string
[]
Amount
[]
Example: 3.25
currency_code string
[]
Currency
[]
Example: USD
rate double
[]
Tax rate
[]
Example: 1
title string
[]
Tax title
[]
Example: taxes
taxable boolean
[]
Tax or not？
[]
Example: true
title string
[]
Product title
[]
Example: beautiful skirt
variant_id string
[]
Product SKU serial number
[]
Example: 18056761559987524812644011
variant_title string
[]
Commodity attribute value, multiple divided by " / ", such as: "155 / red / large"
[]
Example: big
vendor string
[]
Supplier
[]
Example: Supplier
line_item_id string
[]
The ID of the product snapshot table, generated by the system, uniquely confirms a product with the order number
[]
Example: 302
quantity integer
[]
Quantity, quantity of goods
[]
Example: 2
restock_type string
[]
Inventory return type, no_restock-not returned, cancel-cancelled, return-returned only not returned
[]
Example: no_restock
subtotal double
[]
Total refund amount, precision 2
[]
Example: 3.25
subtotal_setobject
[]
Total refund amount, multi-currency information, same on seller and buyer side
presentment_moneyobject
[]
Buy side currency
amount string
[]
Amount
[]
Example: 3.25
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side amount information
amount string
[]
Amount, Precision 2
[]
Example: 3.25
currency_code string
[]
Currency
[]
Example: USD
total_tax double
[]
Tax amount of refunded goods, precision 2
[]
Example: 2.22
total_tax_setobject
[]
Total tax amount, multi-currency information
presentment_moneyobject
[]
Buy side currency
amount string
[]
Amount
[]
Example: 3.25
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side currency
amount string
[]
Amount
[]
Example: 3.25
currency_code string
[]
Currency
[]
Example: USD
transactionsobject[]
[]
Refund transaction information
amount string
[]
Refund amount , accuracy 2
[]
Example: 3.25
created_at string
[]
Creation time
[]
Example: 2012-05-01T14:22:25-04:00
currency string
[]
Currency
[]
Example: USD
id string
[]
Refund ID
[]
Example: 2605659027312156877634
kind string
[]
Transaction type (authorization, capture, sale, void, refund)
[]
Example: authorization
order_id string
[]
Order number
[]
Example: 21056577640603870897253153
processed_at string
[]
Refund order update time ( format see IOS8601 )
[]
Example: 2012-05-01T14:22:25-04:00
status string
[]
Handling status, pending, failure, success, and error
[]
Example: pending
user_id string
[]
Buyer ID
[]
Example: 4201057495
user_id string
[]
User ID
[]
Example: 4201057495
shipping_addressobject
[]
Shipping address
address1 string
[]
Address 1
[]
Example: Address 1
address2 string
[]
Detailed address 2, optional
[]
Example: Address 2
city string
[]
City
[]
Example: New York
company string
[]
Company Name
[]
Example: New company name
country string
[]
Country
[]
Example: USA
country_code string
[]
Country code
[]
Example: US
first_name string
[]
Last name
[]
Example: Tom
last_name string
[]
First name
[]
Example: Washington
latitude string
[]
latitude
[]
Example: 15
longitude string
[]
longitude
[]
Example: 41
name string
[]
Full name
[]
Example: Tom Washington
phone string
[]
Phone
[]
Example: 1320987655
province string
[]
Province
[]
Example: California
province_code string
[]
Province code
[]
Example: 4200006
zip string
[]
Postal code
[]
Example: 92503
shipping_linesobject[]
[]
Logistics information
code string
[]
Logistics number
[]
Example: SF
discount_allocationsobject[]
[]
Discount details
amount string
[]
Discount amount, precision 2
[]
Example: 8.00
amount_setobject
[]
Discount multi-currency amounts
presentment_moneyobject
[]
Buyer side amount information
amount string
[]
Amount, Precision 2
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Store side amount information
amount string
[]
Amount, Precision 2
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
discount_application_index integer
[]
Discount index information : marked in the position of the discount details
[]
Example: 1
discounted_price string
[]
Discount amount, precision 2
[]
Example: 8.00
discounted_price_setobject
[]
Discount multi-currency amounts
presentment_moneyobject
[]
Buyer side amount information
amount string
[]
Amount, Precision 2
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Store side amount information
amount string
[]
Amount, Precision 2
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
phone string
[]
Phone
[]
Example: 13243214565
price string
[]
Logistics freight, precision 2
[]
Example: 8.00
price_setobject
[]
Logistics freight multi-resource information
presentment_moneyobject
[]
Buyer side amount information
amount string
[]
Amount, Precision 2
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Store side amount information
amount string
[]
Amount, Precision 2
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
requested_fulfillment_service_id string
[]
Transportation service code
[]
Example: LX88888
shipping_price string
[]
Original shipping value ( non-discounted amount )
[]
Example: 8.00
shipping_price_setobject
[]
Original shipping value ( non-discounted amount ) , multi-currency information
presentment_moneyobject
[]
Buy side currency
amount string
[]
Amount
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side currency
amount string
[]
Amount
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
source string
[]
Freight source
[]
Example: source
tax_linesobject[]
[]
Logistics tax list
price string
[]
taxes
[]
Example: 8.00
price_setobject
[]
Multi-currency information of tax
presentment_moneyobject
[]
Buyer side amount information
amount string
[]
Amount
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side amount information
amount string
[]
Amount, Precision 2
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
rate double
[]
Tax rate
[]
Example: 1
title string
[]
Tax name
[]
Example: taxes
title string
[]
Logistics name
[]
Example: SF International
store_id string
[]
store ID
[]
Example: 1644828244663
subtotal_price string
[]
Total product price after discount, total product price - marketing discount - artificial discount
[]
Example: 3.25
subtotal_price_setobject
[]
Multi-currency information of total product price after discount
presentment_moneyobject
[]
Buyer side amount information
amount string
[]
Amount, Precision 2
[]
Example: 3.25
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side amount information
amount string
[]
Amount, Precision 2
[]
Example: 3.25
currency_code string
[]
Currency
[]
Example: USD
tags string
[]
order label
[]
Example: Label
tax_linesobject[]
[]
Tax information
price string
[]
Tax amount
[]
Example: 3.25
price_setobject
[]
Multi-currency information of tax
presentment_moneyobject
[]
Buyer side amount information
amount string
[]
Amount, Precision 2
[]
Example: 3.25
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side amount information
amount string
[]
Amount, Precision 2
[]
Example: 3.25
currency_code string
[]
Currency
[]
Example: USD
rate double
[]
Tax rate
[]
Example: 1
title string
[]
Tax name
[]
Example: taxes
tax_number string
[]
TIN
[]
Example: 111111
tax_type string
[]
Types of tax ID
[]
Example: type
taxes_included boolean
[]
Does the total include tax?
total_discounts string
[]
Total discount, marketing discount + artificial discount
[]
Example: 3.25
total_discounts_setobject
[]
Multi-currency information of discount total
presentment_moneyobject
[]
Buyer side amount information
amount string
[]
Amount, Precision 2
[]
Example: 3.25
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side amount information
amount string
[]
Amount, Precision 2
[]
Example: 3.25
currency_code string
[]
Currency
[]
Example: USD
total_line_items_price string
[]
Sum of original prices of goods, precision 2
[]
Example: 8.00
total_line_items_price_setobject
[]
Sum of original price of goods, multi-currency information
presentment_moneyobject
[]
Buyer side amount information
amount string
[]
Amount, Precision 2
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side amount information
amount string
[]
Amount, Precision 2
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
total_outstanding string
[]
Sum of unpaid amount, precision 2
[]
Example: 8.00
total_outstanding_setobject
[]
Not paid amount , multi-currency information
presentment_moneyobject
[]
Buy side currency
amount string
[]
Amount
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side currency
amount string
[]
Amount
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
total_shipping_price_setobject
[]
Order shipping sum, multi-currency information
presentment_moneyobject
[]
Buyer side amount information
amount string
[]
Amount, Precision 2
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side amount information
amount string
[]
Amount, Precision 2
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
total_tax string
[]
Sum of taxes, precision 2, commodity tax + shipping tax
[]
Example: 8.00
total_tax_setobject
[]
Total taxes and fees, multi-currency information
presentment_moneyobject
[]
Buyer side amount information
amount string
[]
Amount, Precision 2
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side amount information
amount string
[]
Amount, Precision 2
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
total_tip_received string
[]
Tip, precision 2
[]
Example: 8.00
total_tip_received_setobject
[]
Tip amount , multi-currency information
presentment_moneyobject
[]
Buy side currency
amount string
[]
Amount
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
shop_moneyobject
[]
Sell side currency
amount string
[]
Amount
[]
Example: 8.00
currency_code string
[]
Currency
[]
Example: USD
total_weight double
[]
Total product weight ( g )
[]
Example: 100
updated_at string
[]
Order update time, (see IOS8601 for the format)
[]
Example: 2012-05-01T14:22:25-04:00
user_id string
[]
Buyer ID
[]
Example: 4201057495

API Explorer

Debugger

Base URL

https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601

ParamOptions

id — path required

Authorization — header required

Body

Body required

{
  "order": {
    "area_code": "86",
    "customer_id": "3100314101",
    "email": "sdaw@gmail.com",
    "id": "1001",
    "line_items": [
      {
        "id": "14865639",
        "tags": "tag1,tag2"
      }
    ],
    "note_attributes": [
      {
        "name": "Note source",
        "value": "Notes"
      }
    ],
    "phone": "18819402211",
    "shipping_address": {
      "address1": "Address 1",
      "address2": "Address 2",
      "area": "Area",
      "area_code": "210002",
      "city": "New York",
      "city_code": "210003",
      "company": "google",
      "country": "united states",
      "country_code": "US",
      "email": "sdaw@gmail.com",
      "first_name": "Lebron",
      "last_name": "James",
      "latitude": "33.111232",
      "longitude": "11.22323",
      "phone": "18819402211",
      "province": "California",
      "province_code": "212221",
      "zip": "123551"
    },
    "tags": "xternal, Inbound, Outbound"
  }
}

Language

curl --request PUT \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601/orders/id.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

Was this article helpful to you?

SHOPLINE

Legal