Fulfillment updated

Event GroupEvent Identification
fulfillmentsfulfillments/update
Occurs whenever a fulfillment is updated.
Request Headers
  • Content-Type string required
    The field must be set to the fixed value application/json; charset=utf-8.
  • X-Shopline-Topic string required
    The unique identifier for the event.
    Example: orders/edited
  • X-Shopline-Hmac-Sha256 string required
    The signature of the request. Upon receiving the request, you must verify the signature to confirm the authenticity and integrity of the data.
    Example: XWmrwMey6OsLMeiZKwP4FppHH3cmAiiJJAweH5Jo4bM=
  • X-Shopline-Shop-Domain string required
    The store domain.
    Example: example.myshopline.com
  • X-Shopline-Shop-Id string required
    The store ID.
    Example: 1610418123456
  • X-Shopline-Merchant-Id string required
    The merchant ID.
    Example: 2000001234
  • X-Shopline-API-Version string required
    The API version.
    Example: v20250601
  • X-Shopline-Webhook-Id string required
    The ID of this Webhook event.
    Example: b54557e48a5fbf7d70bcd043
Request Body
  • 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_service string
    Logistics company name.
  • fulfillment_status string
    The fulfillment status. Valid values are:
    • unshipped: not shipped
    • partial: partially shipped
    • shipped: shipped
  • gift_card boolean
    Whether the product is a gift card.
    • true: Gift card item.
    • false: Not a gift card item.
  • grams double
    The total weight of the product in grams (g).
  • id string
    The ID of the product snapshot table, generated by the system. Combined with the order ID, it uniquely identifies a product.
  • name string
    Product title, same as title .
  • price string
    Product price.
  • 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: USD
  • 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
    The unique identifier for the product.
  • quantity integer
    The number of product variants.
  • requires_shipping boolean
    Indicates whether this product needs to be physically shipped to the customer.
    • true: The product requires shipping.
    • false: The product does not require shipping.
  • sku string
    The product SKU.
  • tax_linesobject[]
    A list of tax information.
  • price string
    The tax amount. The actual tax collected on the product is based on this field value.
  • 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: USD
  • shop_moneyobject
    The tax amount information recorded by the merchant.
  • amount string
    The tax amount. The value is rounded to two decimal places.
    Example: 88.98
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • rate double
    The tax rate, for display only.
  • title string
    The title for the tax description, for display only.
  • taxable boolean
    Indicates whether the product is subject to tax.
    • true：Tax is required.
    • false：No tax is required.
  • title string
    The product title, used for display to the buyer.
  • variant_id string
    Unique variant identifier.
  • variant_title string
    Product variant value. Multiple values are separated by / .
  • vendor string
    Supplier.
  • name string
    Fulfillment code.
  • order_id string
    Order ID.
  • shipment_status string
    Fulfillment shipping status. Valid values are:
    • label_printed: Shipping labels have been printed.
    • label_purchased: Shipping labels have been purchased.
    • attempted_delivery: Indicates that the courier attempted to deliver the package but was unsuccessful.
    • ready_for_pickup: Waiting for the logistics company to pick up the package.
    • picked_up: Logistics company has picked up the package.
    • confirmed: The order has been confirmed by the logistics company.
    • in_transit: Package is in transit.
    • out_for_delivery: Package has arrived at the destination area and is being delivered.
    • delivered: Package has been delivered.
    • failure: For some reason, package delivery failed.
  • status string
    Fulfillment status. Valid values are:
    • success: shipment successful
    • 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 for related information.
  • tracking_info_listobject[]
    A list of fulfillment 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 for related information.
  • tracking_url string
    The domain name of the logistics company.
    DEPRECATED: This parameter is deprecated from API version v20250601. Refer to tracking_info_list for related information.
  • updated_at string
    The date and time when the fulfillment was updated. Format: ISO 8601.
    Example: 2024-08-31T02:20:26+08:00
Status Codes
After receiving a webhook notification from SHOPLINE, you must respond with the following format:
HTTP/1.1 200 OK
For more information about how to subscribe to webhooks and webhook response rules, refer to Webhook overview.
Was this article helpful to you?
SHOPLINE
SHOPLINE
SHOPLINE Enterprise
Legal
Privacy
Terms
Developer Agreement
LinkedInEmail
LinkedInEmail
© Copyright 2013-2025 SHOPLINE Limited.