Cancel fulfillment

Requires write_assigned_fulfillment_orders access scope.

For more info, refer to:

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

Path Parameters

fulfillment_id string required

Package id

Example: "21057401932826316666967110"
order_id string required

Order id

Example: "21057401932826316666967110"

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

fulfillmentobject

Package details
order_id string

Order id
Example: "21057116277667827637773776"
status string

Parcel single status
Example: "success"
updated_at string

Update time
Example: 2022-10-21T08:56:20-04:00
created_at string

Creation time
Example: 2022-10-21T08:56:20-04:00
tracking_number string

Third party tracking number
Example: "UG198768340YP"
name string

Package name
Example: "#21057116277667827637773776.1"
tracking_company string

Logistics company name
Example: "Other"
tracking_numbers array

Third party logistics single number list
Example: ["[\"UG198768340YP\"]"]
tracking_urls array

Logistics tracking url list
Example: ["[\"\"https://tools.usps.com/go/TrackConfirmAction_input?qtc_tLabels1=1Z2345\"\"]"]
line_itemsobject[]

Package Product
fulfillment_quantity integer

Shipping quantity
Example: 1
price_setobject

Item price information
shop_moneyobject

Store price
currency_code string

Currency
Example: "USD"
amount string

Total
Example: "100.00"
presentment_moneyobject

Price
amount string

Total
Example: "100.00"
currency_code string

Currency
Example: "USD"
sku string

Product barcode
Example: "183423409238904944"
total_discount_setobject

Great price information
presentment_moneyobject

Price
amount string

Total
Example: "0.00"
currency_code string

Currency
Example: "USD"
shop_moneyobject

Store price
amount string

Total
Example: "0.00"
currency_code string

Currency
Example: "USD"
requires_shipping boolean

Shipping or not
Example: true
vendor string

Supplier
propertiesobject[]

Additional information
additional string

Additional information
Example: " add-on information "
name string

Custom attribute name
Example: " picture "
type string

Attribute type
Example: "picture"
urls array

Url list
Example: ["[\"https://www.myshopline.com\"]"]
value string

Custom attribute values
Example: "value"
id string

id
Example: "466157049"
variant_id string

Sku serial number
Example: "183423409238904944"
quantity integer

Sku quantity
Example: 1
fulfillable_quantity integer

Remaining quantity can be shipped
Example: 1
name string

Sku title
Example: Trade name
price string

Item price
Example: "100.00"
taxable boolean

Tax or not？
Example: true
total_discount string

Discount
Example: "0.00"
title string

Product title
Example: "Draft"
version string

Product version
Example: "1"
variant_title string

Product attribute value
Example: "Black / Bracelet / Bracelet""
product_id string

Product serial number
Example: "343342675"
grams double

Weight
Example: 10.5
fulfillment_status string

Package tracking
Example: "open"
tax_linesobject[]

Tax item
title string

Tax title
Example: " Product tax "
name string

Tax name
Example: " item tax "
price string

Tax
Example: "10.00"
price_setobject

Multi-currency information of tax
shop_moneyobject

Store price
amount string

Total
Example: "10.00"
currency_code string

Currency
Example: "USD"
presentment_moneyobject

Price
amount string

Total
Example: "10.00"
currency_code string

Currency
Example: "USD"
rate string

Tax rate
Example: "1.00"
tracking_url string

Logistics tracking URL
Example: "https://tools.usps.com/go/TrackConfirmAction_input?qtc_tLabels1=1Z2345"
shipment_status string

Logistics status
Example: "success"
id string

Parcel single id
Example: "4005740193290131085320"

API Explorer

Debugger

Base URL

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

ParamOptions

fulfillment_id — path required

order_id — path required

Authorization — header required

Language

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

Legal