Create a fulfillment based on an order

Requires write_orders access scope.
For more info, refer to:
access permission.
POST https://{handle}.myshopline.com/admin/openapi/v20260301/orders/:order_id/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 .
Create a fulfillment based on a specific order.
Path Parameters
  • order_id string required
    The order ID.
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
    Fulfillment information.
  • line_itemsobject[]
    A list of order product snapshots.
    Maximum size: unlimited
  • id long required
    The ID of the line item snapshot table, generated by the system. Combined with the order ID, it uniquely identifies a line item.
  • quantity integer required
    The quantity of products to be shipped.
  • notify_customer boolean
    Indicates whether to notify the customer when creating or updating a fulfillment.
    • true: Notify the customer by email.
    • false: Do not notify the customer.
    Default value: false
  • tracking_company string
    Logistics service provider.
    DEPRECATED: This parameter is deprecated from API version v20250601. Refer to tracking_info_list.
  • tracking_info_listobject[]
    A list of tracking information. If this parameter is specified, the individual parameters tracking_url, tracking_number, and tracking_company will be ignored.
    Maximum size: 10
  • tracking_company string
    Logistics service provider. Refer to Logistics company list for valid values.
  • tracking_number string
    The delivery tracking number provided by the logistics service provider.
  • tracking_url string
    The domain name of the logistics company.
  • tracking_number string
    The delivery tracking number provided by the logistics service provider.
    DEPRECATED: This parameter is deprecated from API version v20250601. Refer to tracking_info_list.
  • tracking_url string
    The domain name of the logistics company.
    DEPRECATED：This parameter is deprecated from API version v20250601. Refer to tracking_info_list.
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
    Fulfillment information.
  • created_at string
    The date and time when the fulfillment was created. Format: ISO 8601.
    Example: 2024-08-31T02:20:26+08:00
  • id string
    Fulfillment ID.
  • line_itemsobject[]
    A list of line items for the fulfillment.
  • fulfillable_quantity integer
    The remaining quantity of the product that can be shipped.
  • fulfillment_quantity integer
    The quantity of the product shipped in this fulfillment.
  • grams double
    The weight of the product in grams(g).
  • id string
    The ID of the line item snapshot table, generated by the system. Combined with the order ID, it uniquely identifies a line item.
  • name string
    SKU title, same as title .
  • price string
    The product price in store currency. The value is rounded to two decimal places.
  • price_setobject
    The product price, displayed in both the store currency and the buyer currency.
  • presentment_moneyobject
    The product price information presented to the buyer.
  • amount string
    The product price. The value is rounded to two decimal places.
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard.
    Example: CNY
  • shop_moneyobject
    The product price information recorded by the merchant.
  • amount string
    The product price. The value is rounded to two decimal places.
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • product_id string
    SPU serial number.
  • quantity integer
    The quantity ordered for this product.
  • requires_shipping boolean
    Indicates whether the product is subject to shipping：
    • true：Shipping is required
    • false：Shipping is not required
  • sku string
    The product SKU.
  • tax_linesobject[]
    A list of tax information.
  • price string
    Tax in store currency. The value is rounded to two decimal places.
  • price_setobject
    The tax amount, displayed in both the buyer currency and the store currency.
  • presentment_moneyobject
    The tax amount information presented to the buyer.
  • amount string
    The tax amount. The value is rounded to two decimal places.
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard.
    Example: CNY
  • shop_moneyobject
    The tax amount information recorded by the merchant.
  • amount string
    The tax amount. The value is rounded to two decimal places.
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • rate string
    The tax rate, for display only.
  • title string
    The title for the tax description, for display only.
  • taxable boolean
    Whether the product is subject to tax：
    • true：Tax is required
    • false：No tax is required
  • title string
    Product title.
  • total_discount string
    The total discount amount, displayed in the store currency. The value is rounded to two decimal places. It includes promotional discounts, custom item discounts, membership discounts, and other discounts.
  • total_discount_setobject
    Discount amount, displayed in both the buyer currency and the store currency.
  • presentment_moneyobject
    The discount amount information presented to the buyer.
  • amount string
    The discount amount. The value is rounded to two decimal places.
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard.
    Example: CNY
  • shop_moneyobject
    The discount amount information recorded by the merchant.
  • amount string
    The discount amount. The value is rounded to two decimal places.
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • variant_id string
    The unique identifier for the variant.
  • variant_title string
    Product variant value. Multiple values are separated by / .
    Example: big/red
  • version string
    The version of the product.
  • name string
    Fulfillment code.
  • order_id string
    Order number.
  • status string
    Fulfillment status:
    • success：shipment dispatched
    • cancelled：shipment has been canceled
  • tracking_company string
    Logistics service provider.
    DEPRECATED： This parameter is deprecated from API version v20250601. Refer to tracking_info_list.
  • tracking_info_listobject[]
    A list of tracking information.
  • tracking_company string
    Logistics service provider.
  • tracking_number string
    The delivery tracking number provided by the logistics service provider.
  • tracking_url string
    The domain name of the logistics company.
  • tracking_number string
    The delivery tracking number provided by the logistics service provider.
    DEPRECATED：This parameter is deprecated from API version v20250601. Refer to tracking_info_list.
  • tracking_numbers array
    The delivery tracking number provided by the logistics service provider.
    DEPRECATED：This parameter is deprecated from API version v20250601. Refer to tracking_info_list.
  • tracking_url string
    The domain name of the logistics company.
    DEPRECATED: This parameter is deprecated from API version v20250601. Refer to tracking_info_list.
  • tracking_urls array
    The domain name of the logistics company.
    DEPRECATED: This parameter is deprecated from API version v20250601. Refer to tracking_info_list.
  • updated_at string
    The date and time when the fulfillment was updated. Format: ISO 8601.
    Example: 2024-08-31T02:20:26+08:00
API Explorer
https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301

ParamOptions

— path required
— header required

Body

required
{
  "fulfillment": {
    "line_items": [
      {
        "id": 0,
        "quantity": 0
      }
    ],
    "notify_customer": null,
    "tracking_company": null,
    "tracking_info_list": [
      {
        "tracking_company": null,
        "tracking_number": null,
        "tracking_url": null
      }
    ],
    "tracking_number": null,
    "tracking_url": null
  }
}

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/orders/order_id/fulfillments.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'
Examples
Create a fulfillment based on an order
Request
{
  "fulfillment": {
    "line_items": [
      {
        "id": 12345678901234,
        "quantity": 1
      }
    ],
    "notify_customer": true,
    "tracking_company": "ABC",
    "tracking_info_list": [
      {
        "tracking_company": "ABC",
        "tracking_number": 123456789012345,
        "tracking_url": "www.example.com"
      }
    ],
    "tracking_number": 1234567890123458600,
    "tracking_url": "www.example.com"
  }
}
Response
{
  "created_at": 1755482822634,
  "id": "***************32539",
  "line_items": [
    {
      "fulfillable_quantity": 0,
      "fulfillment_quantity": 1,
      "fulfillment_status": "fulfilled",
      "grams": 2,
      "id": 10000000,
      "name": "ABC",
      "price": "26.99",
      "price_set": {
        "presentment_money": {
          "amount": "26.99",
          "currency_code": "USD"
        },
        "shop_money": {
          "amount": "26.99",
          "currency_code": "USD"
        }
      },
      "product_id": "********************53575",
      "quantity": 1,
      "requires_shipping": true,
      "sku": "************7YYS",
      "tax_lines": [
        {
          "price": "0.0",
          "price_set": {
            "presentment_money": {
              "amount": "0.0",
              "currency_code": "USD"
            },
            "shop_money": {
              "amount": "0.0",
              "currency_code": "USD"
            }
          },
          "rate": 1,
          "title": "VAT"
        }
      ],
      "taxable": true,
      "title": "ABC",
      "total_discount": "2.7",
      "total_discount_set": {
        "presentment_money": {
          "amount": "2.7",
          "currency_code": "USD"
        },
        "shop_money": {
          "amount": "2.7",
          "currency_code": "USD"
        }
      },
      "variant_id": "*********************833575",
      "variant_title": null,
      "version": "0"
    }
  ],
  "name": "ABC",
  "order_id": "****************342539",
  "status": "success",
  "tracking_company": "ABC",
  "tracking_number": "*********0HGW",
  "tracking_numbers": [
    "*********0HGW"
  ],
  "tracking_url": "www.example.com",
  "tracking_urls": [
    "www.example.com"
  ],
  "updated_at": 1755482822634
}
Was this article helpful to you?
SHOPLINE
SHOPLINE
SHOPLINE Enterprise
Legal
Privacy
Terms
Developer Agreement
LinkedInEmail
LinkedInEmail
© Copyright 2013-2025 SHOPLINE Limited.