Performance appointment marker onhold

Requires write_assigned_fulfillment_orders access scope.

For more info, refer to:

POST https://{handle}.myshopline.com/admin/openapi/v20260301/fulfillment_orders/:order_id/:fulfillment_order_id/hold.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_order_id string required

Performance order id

Example: "4005740193290131085320"
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 eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

Request Body

fulfillment_holdobject required

Pause shipping reason
reason string required

Pause shipping reason
Example: "out of stock"
reason_notes string

Pause shipping notes
Example: "Not enough inventory to complete this work."

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

fulfillment_orderobject

Order details
line_itemsobject[]

Product line information
shop_id string

store ID
Example: "1644828244663"
variant_id string

Product sku
Example: "18055128824718541486811487"
fulfillable_quantity long

Available in approximately Product quantities
Example: 1
fulfillment_order_id string

Performance order id
Example: "4005740193290131085320"
id string

Performance order Product line id
Example: "1039283"
line_item_id string

Product row id
Example: "518995019"
quantity long

Order Product line Product quantity
Example: 1
request_status string

Request status, including: accepted, cancellation_accepted, cancellation_rejected, cancellation_Requested, closed, rejected, submitted, unsubmitted
Example: "submitted"
fulfillment_holdsobject[]

Shipping pause information
reason string

Delivery suspension reason , out of stock : out of stock , address error : address_error , high-risk fraud : high_fraudulent_risk , waiting for payment : wait_for_payment ,Other : other
Example: "inventory_out_of_stock"
reason_notes string

Shipping pause note
Example: "Not enough inventory to complete this work."
id string

Performance order id
Example: "4005740193290131085320"
order_id string

Order id
Example: "21057401932826316666967110"
delivery_method string

Express order logistics method ,○ STORE_STREET -- super HOME_STREET -- PO_BOX-- self- POST_HOUSE-- self- PICK_UP--Pick up by yourself-seller pick up point ( pick up at store ) ; local delivery by LOCAL_DELIVERY-- ; no shipping required by NONE--
Example: "STORE_STREET"
fulfill_at string

Shipping time ( format see IOS8601 )
Example: "2023-11-19T03:43:00-05:00"
destinationobject

Consignee information
first_name string

Consignee name
Example: "Bob"
last_name string

Consignee last name
Example: "Norman"
province string

Consignee province
Example: Kentucky
address2 string

Consignee address 2
Example: "Chestnut Street 92"
phone string

Consignee phone number
Example: "+1(502)-459-2181"
city string

Consignee city
Example: "Louisville"
zip string

Consignee address zip
Example: "40202"
address1 string

Consignee address 1
Example: "Chestnut Street 92"
email string

Consignee mailbox
Example: "bob.norman@mail.example.com"
company string

Consignee company
Example: "Apple inc"
country string

Consignee country
Example: "United States"
shop_id string

store ID
Example: "1644828244663"
status string

Map order status , including : open , in_progress , cmos ed , cancelled , incomplete , on_hold , scheduled
Example: "open"
supported_actions array

Operation supported by the appointment order includes : create_fulfillment -- created delivery , move -- moved to a new location , hold -- suspended delivery , release_hold -- ( after pause ) started delivery
Example: ["[\"create_fulfillment\"]"]
assigned_locationobject

Location details assigned
name string

Location name
Example: "Apple Api Shipwire"
phone string

Location phone number
Example: "+1(502)-459-3417"
zip string

Location zip code
Example: "40202"
address1 string

Address 1
Example: "Chestnut Street 92"
city string

City
Example: "Louisville"
location_id string

Location id
Example: "5327026538935748524"
province string

Local province
Example: "Kentucky"
address2 string

Address 2
Example: "Chestnut Street 92"
country_code string

Country code
Example: "US"
assigned_location_id string

Assigned location id
Example: "5327026538935748524"

API Explorer

Debugger

Base URL

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

ParamOptions

fulfillment_order_id — path required

order_id — path required

Authorization — header required

Body

Body required

{
  "fulfillment_hold": {
    "reason": "\"out of stock\"",
    "reason_notes": "\"Not enough inventory to complete this work.\""
  }
}

Language

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