Cancel shipping

Requires write_orders access scope.

For more info, refer to:

POST https://{handle}.myshopline.com/admin/openapi/v20260301/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 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 eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

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

fulfillmentobject

Package information
id string

Package ID
status string

Package tracking
tracking_company string

Logistics company name
created_at string

Creation date
line_itemsobject[]

Item group
sku string

Product code
grams double

Weight
product_id string

Product ID
tax_linesobject[]

Tax
title string

Tax name
price string

Amount
price_setobject

Multi-currency amount
presentment_moneyobject

Settlement currency
amount string

Amount
currency_code string

Currency
shop_moneyobject

Store currency
currency_code string

Currency
amount string

Amount
rate string

Tax rate
fulfillment_quantity integer

Shipping quantity
Example: 1
id string

Product ID
quantity integer

Product quantity shipped
title string

Product title
total_discount string

Discount amount
price_setobject

Multi-currency prices
presentment_moneyobject

Settlement currency
amount string

Amount
currency_code string

Currency
shop_moneyobject

Store currency
currency_code string

Currency
amount string

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
version string

Product version
name string

Product name
price string

Price
fulfillable_quantity integer

Available quantity
variant_title string

Product variant name
taxable boolean

Tax or not？
variant_id string

Product variant ID
requires_shipping boolean

Shipping or not
tracking_urls array

Logistics tracking URL group
Example: [""]
updated_at string

Update time
order_id string

Order number
tracking_number string

Tracking number
tracking_numbers array

Tracking number array
Example: [""]
name string

Package
Example: e.g. #1001.1, #1001.2
tracking_url string

Logistics tracking URL

API Explorer

Debugger

Base URL

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

ParamOptions

fulfillment_id — path required

order_id — path required

Authorization — header required

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/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