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

Requires write_assigned_fulfillment_orders access scope.

For more info , refer to:

[]

access permission

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

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
company string
[]
Logistics company
[]
Example: "my-company"
number string
[]
Logistics single number
[]
Example: "UG15439033"
url string
[]
Track links
[]
Example: http://www.my-url.com
order_id string required
[]
Order id
[]
Example: "21057116277667827637773776"

Response

[]

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

Response Headers

traceId
[]
traceId

Response Body

fulfillmentobject
[]
Package details
created_at string
[]
Creation time
[]
Example: 2022-10-21T08:56:20-04:00
id string
[]
Parcel single id
[]
Example: "4005740193290131085320"
line_itemsobject[]
[]
Package Product
fulfillable_quantity integer
[]
Remaining quantity can be shipped
[]
Example: 1
fulfillment_quantity integer
[]
Shipping quantity
[]
Example: 1
fulfillment_status string
[]
Package tracking
[]
Example: "open"
grams double
[]
Weight
[]
Example: 10.5
id string
[]
id
[]
Example: "466157049"
name string
[]
Sku title
[]
Example: Trade name
price string
[]
Item price
[]
Example: "100.00"
price_setobject
[]
Item price information
presentment_moneyobject
[]
Price
amount string
[]
Total
[]
Example: "100.00"
currency_code string
[]
Currency
[]
Example: "USD"
shop_moneyobject
[]
Store price
amount string
[]
Total
[]
Example: "100.00"
currency_code string
[]
Currency
[]
Example: "USD"
product_id string
[]
Product serial number
[]
Example: "343342675"
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"
quantity integer
[]
Sku quantity
[]
Example: 1
requires_shipping boolean
[]
Shipping or not
[]
Example: true
sku string
[]
Product barcode
[]
Example: "183423409238904944"
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 "
taxable boolean
[]
Tax or not？
[]
Example: true
title string
[]
Product title
[]
Example: "Draft"
total_discount string
[]
Discount
[]
Example: "0.00"
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"
variant_id string
[]
Sku serial number
[]
Example: "183423409238904944"
variant_title string
[]
Product attribute value
[]
Example: "Black / Bracelet / Bracelet""
vendor string
[]
Supplier
version string
[]
Product version
[]
Example: "1"
location_id string
[]
Location id
[]
Example: "54039222210"
name string
[]
Package name
[]
Example: "#21057116277667827637773776.1"
order_id string
[]
Order id
[]
Example: "21057116277667827637773776"
shipment_status string
[]
Logistics status
[]
Example: "success"
status string
[]
Parcel single status
[]
Example: "success"
tracking_company string
[]
Logistics company name
[]
Example: "Other"
tracking_number string
[]
Third party tracking number
[]
Example: "UG198768340YP"
tracking_numbers array
[]
Third party logistics single number list
[]
Example: ["UG198768340YP"]
tracking_url string
[]
Logistics tracking URL
[]
Example: "https://tools.usps.com/go/TrackConfirmAction_input?qtc_tLabels1=1Z2345"
tracking_urls array
[]
Logistics tracking url list
[]
Example: [""https://tools.usps.com/go/TrackConfirmAction_input?qtc_tLabels1=1Z2345""]
updated_at string
[]
Update time
[]
Example: 2022-10-21T08:56:20-04:00

API Explorer

Debugger

Base URL

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

ParamOptions

Authorization — header required

Body

Body required

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

Language

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