Cancel order archive

Requires write_orders access scope.
For more info, refer to:
access permission.
PUT https://{handle}.myshopline.com/admin/openapi/v20261201/orders/:id/cancel_hide_mark.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 .
Opens a closed order.
Path Parameters
  • id string required
    Order number
    Example: 21050342939778451436179579
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 to obtain the access token, and then pass the obtained token in the Bearer format.
    Example:
    Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA
Status Codes
For the complete list of codes and messages, see Http status code.
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
  • orderobject
    For order information, field descriptions and examples, please refer to the response result of the order list
  • line_itemsobject[]
    Order product snapshot information
  • quantity integer
    Quantity of items in the order
    Example: 2
  • location_id string
    The location corresponding to the store in the pos scene
    Example: 5327026538935748524
  • fulfillment_status string
    The shipping status of the product, shipping status, fulfilled-shipped; partial-partially shipped; null-unshipped;
    Example: fulfilled
  • taxable boolean
    Tax or not？
    Example: true
  • price string
    Commodity price, precision 2
    Example: 3.25
  • discount_allocationsobject[]
    Marketing discount detail amount multi-currency
  • amount_setobject
    Discount Details Amount Multi-Currency
  • shop_moneyobject
    Store currency
  • amount string
    Amount, Precision 2
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • presentment_moneyobject
    payment currency
  • amount string
    Amount, Precision 2
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • discount_application_index integer
    Indicate the location in the discount details
    Example: 1
  • amount string
    Discount detail amount
    Example: 8.00
  • variant_title string
    Commodity attribute value, multiple divided by " / ", such as: "155 / red / large"
    Example: big
  • product_id string
    SPU serial number
    Example: 16056761559984840457934011
  • fulfillable_quantity integer
    Available quantity
    Example: 1
  • propertiesobject[]
    Product customization information
  • 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
  • additional string
    Additional Fields for Custom Items
    Example: Additional field
  • tax_linesobject[]
    Tax information
  • title string
    Tax name
    Example: tax
  • 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
    Example: shipping_tax
  • price string
    Tax, precision 2
    Example: 3.25
  • price_setobject
    Multi-currency information of tax
  • presentment_moneyobject
    Buy side currency
  • currency_code string
    Currency
    Example: USD
  • amount string
    Amount
    Example: 3.25
  • shop_moneyobject
    Sell side currency
  • amount string
    Amount
    Example: 3.25
  • currency_code string
    Currency
    Example: USD
  • rate double
    Tax rate
    Example: 1
  • fulfillment_service string
    Logistics company name
    Example: Sf
  • requires_shipping boolean
    Shipping or not
    Example: true
  • grams double
    Weight ( grams )
    Example: 100
  • sku string
    Product code, barCode
    Example: 18056761559987524812644011
  • tags string
    Commodity tags (separated by multiple commas)
    Example: Tag 1 , cute
  • vendor string
    Supplier
    Example: Supplier
  • title string
    Product title
    Example: Nice looking skirt
  • attribute string
    Product attributes : name-attribute value multiple comma " , " division like : color-red , size-x
    Example: red
  • variant_id string
    Product SKU serial number
    Example: 18056761559987524812644011
  • id string
    The ID of the product snapshot table, generated by the system, uniquely confirms a product with the order number
    Example: 417
  • name string
    SKU title, same as title
    Example: Product title
  • total_weight double
    Total product weight ( g )
    Example: 100
  • client_detailsobject
    Client Details
  • 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
  • browser_ip string
    Client ip address
    Example: 157.119.232.35
  • session_hash string
    Member session encryption information
    Example: c2c4a58186b9d96395d7e6b5c2969577
  • 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
  • current_total_price string
    Total tax, product tax + shipping tax
    Example: 8.00
  • app_id string
    App ID
    Example: 222222
  • order_status_url string
    Order status page URL
    Example: https://shoptest.myshoplinestg.com/trade/thank_you?mainOrderMark=xxx&mainOrderSeq=200565776406008509
  • 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
  • value string
    The specific value of the discount ( it can be n-fold , or it can be the specific amount value )
    Example: 20
  • code string
    Discount code
    Example: 1Q3UMQM8RBP5
  • title string
    automatic discount title
    Example: Discount title
  • type string
    Discount type
    Example: manual
  • description string
    Description of custom discount
    Example: Discount description
  • target_type string
    1）line_item、shipping_line
    Example: line_item
  • 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 )
    Example: explicit
  • value_type string
    % discount , amount discount
    Example: fixed_amount
  • shipping_addressobject
    Shipping address
  • address2 string
    Detailed address 2, optional
    Example: Address 2
  • name string
    Full name
    Example: Tom Washington
  • country_code string
    Country code
    Example: US
  • last_name string
    First name
    Example: Washington
  • phone string
    Phone
    Example: 1320987655
  • province string
    Province
    Example: California
  • address1 string
    Address 1
    Example: Address 1
  • company string
    Company name
    Example: New company name
  • latitude string
    Latitude
    Example: 15
  • zip string
    Postal code
    Example: 92503
  • country string
    Country
    Example: Usa
  • first_name string
    Last name
    Example: Tom
  • city string
    City
    Example: New York
  • longitude string
    Longitude
    Example: 41
  • province_code string
    Province code
    Example: 4200006
  • tax_number string
    TIN
    Example: 111111
  • total_tax string
    Sum of taxes, precision 2, commodity tax + shipping tax
    Example: 8.00
  • 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: Notes source
  • value string
    Notes
    Example: Notes
  • current_subtotal_price string
    Sum of current products, total price of products * quantity
    Example: 78.08
  • total_line_items_price string
    Sum of original prices of goods, precision 2
    Example: 8.00
  • 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
  • subtotal_price_setobject
    Multi-currency information of total product price after discount
  • shop_moneyobject
    Sell side amount information
  • amount string
    Amount, Precision 2
    Example: 3.25
  • currency_code string
    Currency
    Example: USD
  • presentment_moneyobject
    Buyer side amount information
  • amount string
    Amount, Precision 2
    Example: 3.25
  • currency_code string
    Currency
    Example: USD
  • note string
    Merchant notes
    Example: Notes
  • subtotal_price string
    Total product price after discount, total product price - marketing discount - artificial discount
    Example: 3.25
  • 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
  • processed_user_id string
    order creator
    Example: 4201057495
  • total_tip_received string
    Tip, precision 2
    Example: 8.00
  • 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
  • total_outstanding string
    Sum of unpaid amount, precision 2
    Example: 8.00
  • email string
    Buyer's mailbox, there must be one of the two
    Example: test1002@Gmail.com
  • fulfillmentsobject[]
    Package information
  • line_itemsobject[]
    Product list
  • variant_title string
    Commodity attribute value, multiple divided by " / ", such as: "155 / red / large"
    Example: big
  • requires_shipping boolean
    Shipping or not
  • fulfillable_quantity integer
    Available quantity
    Example: 1
  • fulfillment_status string
    The shipping status of the product, shipping status, fulfilled-shipped; partial-partially shipped; null-unshipped;
    Example: fulfilled
  • title string
    Product title
    Example: Beautiful skirt
  • variant_id string
    Product SKU serial number
    Example: 18056761559987524812644011
  • taxable boolean
    Tax or not？
    Example: true
  • name string
    SKU title, same as title
    Example: Product name
  • price string
    Commodity price, precision 2
    Example: 23.09
  • quantity integer
    Quantity of items in the order
    Example: 1
  • attribute string
    Product attributes : name-attribute value multiple comma " , " division like : color-red , size-x
    Example: red
  • vendor string
    Supplier
    Example: Supplier
  • sku string
    Product code, barCode
    Example: 18056761559987524812644011
  • grams double
    Weight ( grams )
    Example: 100
  • product_id string
    SPU serial number
    Example: 16056761559984840457934011
  • fulfillment_service string
    Logistics company name
    Example: Sf
  • id string
    The ID of the product snapshot table, generated by the system, uniquely confirms a product with the order number
    Example: 312
  • tax_linesobject[]
    Tax information
  • title string
    Tax name
    Example: tax
  • 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
  • shipment_status string
    Package tracking
    Example: fulfilled
  • tracking_company string
    Logistics company name
    Example: SF International
  • id string
    Package number
    Example: 22046737798141702810214336
  • name string
    invoice short number
    Example: 1032-F2
  • tracking_number string
    Third party tracking number
    Example: yun0001
  • tracking_url string
    Logistics company URL
    Example: https://www.sf-international.com/
  • status string
    Logistics delivery status, success-shipped; cancelled-cancelled;
    Example: cancelled
  • updated_at string
    Update time (see IOS8601 for the format)
    Example: 2012-05-01T14:22:25-04:00
  • order_id string
    Order number
    Example: 21056577640603870897253153
  • created_at string
    Creation time (see IOS8601 for the format)
    Example: 2012-05-01T14:22:25-04:00
  • 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
  • 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_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
  • line_itemobject
    Refund Product line
  • product_id string
    SPU serial number
    Example: 16056761559984840457934011
  • grams double
    Weight ( grams )
    Example: 100
  • attribute string
    Product attributes : name-attribute value multiple comma " , " division like : color-red , size-x
    Example: red
  • fulfillment_service string
    Logistics company name
    Example: Sf
  • requires_shipping boolean
    Shipping or not
    Example: true
  • sku string
    Product code, barCode
    Example: 18056761559987524812644011
  • variant_id string
    Product SKU serial number
    Example: 18056761559987524812644011
  • id string
    The ID of the product snapshot table, generated by the system, uniquely confirms a product with the order number
    Example: 312
  • price string
    Commodity price, precision 2
    Example: 3.25
  • variant_title string
    Commodity attribute value, multiple divided by " / ", such as: "155 / red / large"
    Example: big
  • name string
    SKU title, same as title
    Example: test-002
  • quantity integer
    Quantity of items in the order
    Example: 2
  • fulfillment_status string
    The shipping status of the product, shipping status, fulfilled-shipped; partial-partially shipped; null-unshipped;
    Example: fulfilled
  • title string
    Product title
    Example: Beautiful skirt
  • 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: tax
  • taxable boolean
    Tax or not？
    Example: true
  • vendor string
    Supplier
    Example: Supplier
  • fulfillable_quantity integer
    Available quantity
    Example: 2
  • subtotal double
    Total refund amount, precision 2
    Example: 3.25
  • 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
  • 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
  • currency_code string
    Currency
    Example: USD
  • amount string
    Amount
    Example: 3.25
  • total_tax double
    Tax amount of refunded goods, precision 2
  • transactionsobject[]
    Refund transaction information
  • amount string
    Refund amount , accuracy 2
    Example: 3.25
  • 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
  • user_id string
    Buyer ID
    Example: 4201057495
  • currency string
    Currency
    Example: USD
  • id string
    Refund ID
    Example: 2605659027312156877634
  • status string
    Handling status, pending, failure, success, and error
    Example: pending
  • created_at string
    Creation time
    Example: 2012-05-01T14:22:25-04:00
  • kind string
    Transaction type (authorization, capture, sale, void, refund)
    Example: authorization
  • user_id string
    User ID
    Example: 4201057495
  • total_line_items_price_setobject
    Sum of original price of goods, multi-currency information
  • shop_moneyobject
    Sell side amount information
  • amount string
    Amount, Precision 2
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • presentment_moneyobject
    Buyer side amount information
  • amount string
    Amount, Precision 2
    Example: 8.00
  • currency_code string
    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
  • financial_status string
    Payment status , un pad , authorized , pending , partially_paid , pad , partially_refunded , refunded
    Example: unpaid
  • tax_type string
    Types of tax ID
    Example: type
  • 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"]
  • name string
    Custom order number
    Example: test1001
  • currency string
    Transaction currency
    Example: USD
  • updated_at string
    Order update time, (see IOS8601 for the format)
    Example: 2012-05-01T14:22:25-04:00
  • shipping_linesobject[]
    Logistics information
  • requested_fulfillment_service_id string
    Transportation service code
    Example: LX88888
  • shipping_price string
    The value of the original shipping fee (not the amount after the discount)
    Example: 8.00
  • price string
    Logistics freight, precision 2
    Example: 8.00
  • source string
    Shipping source
    Example: source
  • tax_linesobject[]
    Logistics tax list
  • rate double
    Tax rate
    Example: 1
  • title string
    Tax name
    Example: tax
  • price string
    tax
    Example: 8.00
  • price_setobject
    Multi-currency information of tax
  • presentment_moneyobject
    Buyer side amount information
  • currency_code string
    Currency
    Example: USD
  • amount string
    Amount
    Example: 8.00
  • shop_moneyobject
    Sell side amount information
  • currency_code string
    Currency
    Example: USD
  • amount string
    Amount, Precision 2
    Example: 8.00
  • code string
    Logistics number
    Example: SF
  • discount_allocationsobject[]
    Discount Details
  • amount string
    Discount amount, precision 2
    Example: 8.00
  • amount_setobject
    Discount Multi-Currency Amount
  • shop_moneyobject
    Amount information on the store side
  • currency_code string
    Currency
    Example: USD
  • amount string
    Amount, Precision 2
    Example: 8.00
  • presentment_moneyobject
    Buyer 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
  • 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
    Amount information on the store side
  • amount string
    Amount, Precision 2
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • discounted_price string
    Discount amount, precision 2
    Example: 8.00
  • discounted_price_setobject
    Discount Multi-Currency Amount
  • shop_moneyobject
    Amount information on the store side
  • amount string
    Amount, Precision 2
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • presentment_moneyobject
    Buyer side amount information
  • amount string
    Amount, Precision 2
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • title string
    Logistics name
    Example: SF International
  • phone string
    Phone
    Example: 13243214565
  • 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
  • shop_moneyobject
    Sell side amount
  • amount string
    Amount, Precision 2
    Example: 78.08
  • currency_code string
    Currency code
    Example: USD
  • presentment_moneyobject
    Buy side currency
  • amount string
    Amount
    Example: 78.08
  • currency_code string
    Currency
    Example: USD
  • presentment_currency string
    Buy side currency, same as sell side currency
    Example: USD
  • taxes_included boolean
    Does the total include tax?
  • checkout_token string
    Settlement page token
    Example: c2c4a58186b9d96395d7e6b5c2969577
  • 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
  • current_total_discounts string
    Sum of discounts, precision 2, marketing offers + artificial discounts
    Example: 3.25
  • tags string
    order label
    Example: Tag
  • cart_token string
    Shopping cart token
    Example: c2c4a58186b9d96395d7e6b5c2969577
  • customer_locale string
    Buyer country, language code + country name abbreviation
    Example: enCN
  • payment_detailsobject[]
    Payment slip information
  • status_msg string
    Payment order status code description
    Example: PENDING_REVIEW
  • create_time string
    Payment slip creation time
    Example: 2012-05-01T14:22:25-04:00
  • order_seq string
    Order number
    Example: 23057287797738260472676128
  • pay_channel_deal_id string
    External channel payment serial number
    Example: pi_3MI897Hezv8FxjBO1uGxMPhX
  • 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
  • pay_amount double
    Payment amount
    Example: 3.25
  • pay_status string
    Payment slip status , unpaid- not paid ; pending- paying ; risking- wind control ; paid-paid ; paid_overtime- payment failed ; paid_failed- payment failure ;
    Example: unpaid
  • pay_seq string
    Payment slip number
    Example: 23057287797738260472676128
  • current_total_tax_setobject
    Multi-currency information of the sum of taxes, the currency and amount of buyers and sellers are the same
  • shop_moneyobject
    Sell side currency
  • amount string
    Amount
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • presentment_moneyobject
    Buy side currency
  • currency_code string
    Currency
    Example: USD
  • amount string
    Amount
    Example: 8.00
  • total_discounts_setobject
    Multi-currency information of discount total
  • presentment_moneyobject
    Buyer side amount information
  • currency_code string
    Currency
    Example: USD
  • amount string
    Amount, Precision 2
    Example: 3.25
  • shop_moneyobject
    Sell side amount information
  • amount string
    Amount, Precision 2
    Example: 3.25
  • currency_code string
    Currency
    Example: USD
  • billing_addressobject
    billing address
  • city string
    Billing consignee city ( up to 64 characters )
    Example: New York
  • phone string
    Bill consignee name mobile phone number
    Example: 13890312312
  • province string
    Billing consignee name province
    Example: California
  • first_name string
    Billing consignee name
    Example: Tom
  • country string
    Billing consignee country ( up to 64 characters )
    Example: Usa
  • country_code string
    Billing consignee national encoding
    Example: US
  • name string
    Billing name
    Example: Tom Washington
  • last_name string
    Bill consignee last name
    Example: Washington
  • address2 string
    Bill consignee additional to detailed address ( up to 255 characters )
    Example: Address 2
  • province_code string
    Billing consignee name province encoding
    Example: 4300006
  • address1 string
    Billing consignee detailed address ( up to 255 characters )
    Example: Address 1
  • company string
    Company name
    Example: new company
  • zip string
    Billing consignee name zip
    Example: 521000
  • store_id string
    store ID
    Example: 1644828244663
  • created_at string
    Order creation time (see IOS8601 for the format)
    Example: 2012-05-01T14:22:25-04:00
  • discount_codesobject[]
    Promo code information
  • 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: deduction amount
  • amount string
    Discount amount, precision 2
    Example: 3.25
  • code string
    Promo code
    Example: KIN4GNAB2FRH
  • checkout_id string
    Discard id
    Example: 2404785166526352972864
  • deduct_member_point_amount string
    Current order member point deduction amount
    Example: 3.25
  • browser_ip string
    Client IP
    Example: 157.119.232.35
  • current_total_tax string
    Total tax, product tax + shipping tax
    Example: 8.00
  • tax_linesobject[]
    Tax information
  • price string
    Tax amount
    Example: 3.25
  • price_setobject
    Multi-currency information of tax
  • presentment_moneyobject
    Buyer side amount information
  • currency_code string
    Currency
  • amount string
    Amount, Precision 2
    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: tax
  • customerobject
    Buyer information
  • phone string
    User mobile phone number
    Example: 19872121232
  • updated_at string
    Buyer update time
    Example: 2012-05-01T14:22:25-04:00
  • email string
    User mailbox
    Example: test001@Gmail.com
  • last_name string
    Last name
    Example: Washington
  • addressesobject
    Buyer address information
  • city string
    City
    Example: New York
  • province_code string
    Province code
    Example: 4300006
  • address1 string
    Detailed address 1
    Example: Address 1
  • last_name string
    First name
    Example: Washington
  • country_code string
    Country code
    Example: US
  • name string
    Full name
    Example: Tom Washington
  • country string
    Country
    Example: Usa
  • first_name string
    Last name
    Example: Tom
  • province string
    Province
    Example: California
  • address2 string
    Detailed address 2, optional
    Example: Address 2
  • phone string
    Phone
    Example: 13652133421
  • zip string
    Postal code
    Example: 52134
  • created_at string
    Buyer creation time (see IOS8601 for the format)
    Example: 2012-05-01T14:22:25-04:00
  • currency string
    Currency
    Example: USD
  • first_name string
    First name
    Example: Tom
  • id string
    User ID
    Example: 4201057495
  • area_code string
    Phone area code
    Example: +86
  • total_discounts string
    Total discount, marketing discount + artificial discount
    Example: 3.25
  • total_tax_setobject
    Tax summation, 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
  • id string
    Order number , system customization number
    Example: 21050224312121887324667162
  • phone string
    Buyer contact information, there must be one of the two
    Example: 12903001000
  • cancel_reason string
    Seller's reason for cancellation
    Example: " don ' t want to buy "
  • user_id string
    Buyer ID
    Example: 4201057495
  • user_errorsobject[]
    Error prompt information in this execution , if the implementation result is wrong , this field will return error information
  • code string
    Wrong code
    Example: illegal param
  • field array
    Path that causes incorrect input fields
    Example: [""]
  • message string
    Error message
API Explorer
https://openapiceshidianpu.myshopline.com/admin/openapi/v20261201

ParamOptions

— path required
— header required

Language

curl --request PUT \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20261201/orders/id/cancel_hide_mark.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'
Was this article helpful to you?
SHOPLINE
SHOPLINE
SHOPLINE Enterprise
Legal
Privacy
Terms
Developer Agreement
LinkedInEmail
LinkedInEmail
© Copyright 2013-2026 SHOPLINE Limited.