Cancel shipping

Requires write_orders access scope.

For more info , refer to:

[]

access permission

POST https://{handle}.myshopline.com/admin/openapi/v20250601/orders/:order_id/fulfillments/:fulfillment_id/cancel.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 .

[]

Order shipment cancellation

Path Parameters

fulfillment_id string required
[]
Package id
order_id string required
[]
Order number

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

Response

[]

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

Response Headers

traceId
[]
traceId

Response Body

fulfillmentobject
[]
Package information
created_at string
[]
Creation date
id string
[]
Package ID
line_itemsobject[]
[]
Item group
fulfillable_quantity integer
[]
Available quantity
fulfillment_quantity integer
[]
Shipping quantity
[]
Example: 1
grams double
[]
Weight
id string
[]
Product ID
name string
[]
Product name
price string
[]
Price
price_setobject
[]
Multi-currency prices
presentment_moneyobject
[]
Settlement currency
amount string
[]
Amount
currency_code string
[]
Currency
shop_moneyobject
[]
Store currency
amount string
[]
Amount
currency_code string
[]
Currency
product_id string
[]
Product ID
quantity integer
[]
Product quantity shipped
requires_shipping boolean
[]
Shipping or not
sku string
[]
Product code
tax_linesobject[]
[]
Tax
price string
[]
Amount
price_setobject
[]
Multi-currency amount
presentment_moneyobject
[]
Settlement currency
amount string
[]
Amount
currency_code string
[]
Currency
shop_moneyobject
[]
Store currency
amount string
[]
Amount
currency_code string
[]
Currency
rate string
[]
Tax rate
title string
[]
Tax name
taxable boolean
[]
Tax or not？
title string
[]
Product title
total_discount string
[]
Discount amount
total_discount_setobject
[]
Multi-currency discount
presentment_moneyobject
[]
Settlement currency
amount string
[]
Amount
currency_code string
[]
Currency
shop_moneyobject
[]
Store currency
amount string
[]
Amount
currency_code string
[]
Currency
variant_id string
[]
Product variant ID
variant_title string
[]
Product variant name
version string
[]
Product version
name string
[]
Package
[]
Example: e.g. #1001.1, #1001.2
order_id string
[]
Order number
status string
[]
Package tracking
tracking_company string
[]
Logistics company name
tracking_number string
[]
Tracking number
tracking_numbers array
[]
Tracking number array
[]
Example: ``
tracking_url string
[]
Logistics tracking URL
tracking_urls array
[]
Logistics tracking URL group
[]
Example: ``
updated_at string
[]
Update time

API Explorer

Debugger

Base URL

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

ParamOptions

fulfillment_id — path required

order_id — path required

Authorization — header required

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601/orders/order_id/fulfillments/fulfillment_id/cancel.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