Create an fulfillment for the fulfillment order ( single or batch )

Requires write_assigned_fulfillment_orders access scope.

For more info, refer to:

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

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

fulfillmentobject required

Parcel single logistics information
line_items_by_fulfillment_orderobject[] required

List of order number
fulfillment_order_id string required

Order number
Example: "1046000807"
fulfillment_order_line_itemsobject[]

Performance order Product line
id string required

Order for sale Product line id
Example: 6076
quantity integer required

Shipping quantity
Example: 2
message string

Notification information
Example: "he package was shipped this morning."
notify_customer boolean

Notify consumers or not
Example: true
tracking_infoobject

Logistics information.

DEPRECATED: This parameter is deprecated from API version v20250601. Refer to tracking_info_list.
company string

Logistics company
Example: "my-company"
number string

Logistics single number
Example: "UG15439033"
url string

Track links
Example: http://www.my-url.com
tracking_info_listobject[]

If this parameter is specified, the individual parameters tracking_url, tracking_number, and tracking_company will be ignored.Maximum of 10 tracking infos allowed.
tracking_url string

Logistics tracking URL.
Example: http://www.my-url.com
tracking_company string

Logistics company name.
Example: "my-company"
tracking_number string

Tracking number.
Example: "UG15439033"
order_id string required

Order id
Example: "21057116277667827637773776"

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

Parcel single id
Example: "4005740193290131085320"
line_itemsobject[]

Package Product
sku string

Product barcode
Example: "183423409238904944"
title string

Product title
Example: "Draft"
total_discount string

Discount
Example: "0.00"
fulfillment_quantity integer

Shipping quantity
Example: 1
requires_shipping boolean

Shipping or not
Example: true
tax_linesobject[]

Tax item
name string

Tax name
Example: " item tax "
price string

Tax
Example: "10.00"
price_setobject

Multi-currency information of tax
presentment_moneyobject

Price
amount string

Total
Example: "10.00"
currency_code string

Currency
Example: "USD"
shop_moneyobject

Store price
amount string

Total
Example: "10.00"
currency_code string

Currency
Example: "USD"
rate string

Tax rate
Example: "1.00"
title string

Tax title
Example: " Product tax "
total_discount_setobject

Great price information
shop_moneyobject

Store price
amount string

Total
Example: "0.00"
currency_code string

Currency
Example: "USD"
presentment_moneyobject

Price
amount string

Total
Example: "0.00"
currency_code string

Currency
Example: "USD"
variant_id string

Sku serial number
Example: "183423409238904944"
variant_title string

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

Supplier
fulfillment_status string

Package tracking
Example: "open"
price string

Item price
Example: "100.00"
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"
product_id string

Product serial number
Example: "343342675"
propertiesobject[]

Additional information
type string

Attribute type
Example: "picture"
urls array

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

Custom attribute values
Example: "value"
additional string

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

Custom attribute name
Example: " picture "
taxable boolean

Tax or not？
Example: true
version string

Product version
Example: "1"
fulfillable_quantity integer

Remaining quantity can be shipped
Example: 1
grams double

Weight
Example: 10.5
id string

id
Example: "466157049"
name string

Sku title
Example: Trade name
quantity integer

Sku quantity
Example: 1
location_id string

Location id
Example: "54039222210"
order_id string

Order id
Example: "21057116277667827637773776"
shipment_status string

Logistics status
Example: "success"
tracking_company string

Logistics company name.

DEPRECATED: This parameter is deprecated from API version v20250601. Refer to tracking_info_list for related information.
Example: "Other"
tracking_numbers array

Third party logistics single number list
Example: ["[\"UG198768340YP\"]"]
tracking_url string

Logistics tracking URL.

DEPRECATED: This parameter is deprecated from API version v20250601. Refer to tracking_info_list for related information.
Example: "https://tools.usps.com/go/TrackConfirmAction_input?qtc_tLabels1=1Z2345"
tracking_info_listobject[]

If this parameter is specified, the individual parameters tracking_url, tracking_number, and tracking_company will be ignored.Maximum of 10 tracking infos allowed.
tracking_url string

Logistics tracking URL
tracking_company string

Logistics company name
tracking_number string

Third party tracking number
tracking_urls array

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

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

Package name
Example: "#21057116277667827637773776.1"
status string

Parcel single status
Example: "success"
tracking_number string

Third party tracking number.

DEPRECATED: This parameter is deprecated from API version v20250601. Refer to tracking_info_list for related information.
Example: "UG198768340YP"
updated_at string

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

API Explorer

Debugger

Base URL

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

ParamOptions

Authorization — header required

Body

Body required

{
  "fulfillment": {
    "notify_customer": true,
    "tracking_info": {
      "number": "\"UG15439033\"",
      "url": "http://www.my-url.com",
      "company": "\"my-company\""
    },
    "tracking_info_list": [
      {
        "tracking_company": "\"my-company\"",
        "tracking_number": "\"UG15439033\"",
        "tracking_url": "http://www.my-url.com"
      }
    ],
    "line_items_by_fulfillment_order": [
      {
        "fulfillment_order_id": "\"1046000807\"",
        "fulfillment_order_line_items": [
          {
            "id": "6076",
            "quantity": 2
          }
        ]
      }
    ],
    "message": "\"he package was shipped this morning.\""
  },
  "order_id": "\"21057116277667827637773776\""
}

Language

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