🔒 The Update Fulfillment API updates the details of an existing fulfillment, including tracking information and notification preferences. This enables users to modify tracking data and notify customers via email.
This API is especially useful for:
Updating shipment tracking information.
Resending fulfillment email notifications to customers.
Modifying tracking URLs or logistics company details.
📘 Parameter Type Required Example Description order_idstring Yes 633130-00000012Unique identifier for the order. fulfillment_idstring Yes 49a731b0-1b7e-47c3-94d9-6d688f36201eUnique identifier for the fulfillment.
Parameter Type Required Description Example fulfillmentobject Yes Fulfillment details object {...}fulfillment. tracking_numberstring Yes Tracking number for the shipment UPS123456789fulfillment. tracking_companystring No Name of the shipping carrier UPSfulfillment. tracking_company_codestring No Shipping carrier code upsfulfillment. tracking_urlstring No URL to track the shipment https://www.ups.com/track?tracknum=123456789fulfillment. phone_numberstring No Contact phone number for the shipment +1-800-123-4567send_emailboolean No trueWhether to send email notifications to customers.true
email## Response Explanation
📘 Field Type Description Example codestring "success"Response status code messagestring Descriptive message of the response data.fulfillmentobject fulfillment fulfillment details
Parameter Type Example Description idstring ful_123456Unique identifier for the fulfillment order_idstring ord_123456ID of the associated order statusstring successStatus of the fulfillment creation created_atstring 2023-06-01T00:00:00ZCreation time (ISO 8601 format) updated_atstring 2023-06-01T00:00:00ZLast modified time (ISO 8601 format) tracking_companystring UPSShipping carrier name tracking_numberstring UPS123456789Tracking number tracking_company_codestring upsShipping carrier code line_itemsarray of objects [ {...}, {...} ]List of fulfilled line items
Parameter Type Example Description idstring li_123456Line item ID product_idstring prod_123456Product ID product_titlestring Premium T-ShirtProduct name variant_idstring var_123456Variant ID variant_titlestring Blue, Size MVariant title quantityuint32 2Quantity fulfilled notestring Fragile itemMerchant or customer note imageobject {...}Product image details pricestring 19.99Product price compare_at_pricestring 29.99Original price (if on sale) total_pricestring 39.98Total price for quantity fulfillment_statusstring fulfilledFulfillment status skustring TSKU123Stock Keeping Unit weightstring 0.5Product weight weight_unitstring kgWeight unit vendorstring Clothing Co.Product vendor product_urlstring https://example.com/products/premium-tshirtProduct page URL created_atstring 2023-05-01T00:00:00ZLine item creation time updated_atstring 2023-06-01T00:00:00ZLine item last update time optionsarray of objects [ {...} ]Product variant options taxableboolean trueWhether item is taxable requires_shippingboolean trueWhether item requires shipping spustring SPU123Standard Product Unit product_tagsstring new, bestsellerProduct tags refund_quantity_totaluint32 0Total refunded quantity ship_quantityuint32 2Quantity shipped customboolean falseWhether item is custom trunk_pricestring 0.0Trunk price (if applicable) discount_applicationsstring []Discount applications tax_pricestring 3.20Tax amount duty_pricestring 0.0Duty cost tracking_urlstring https://www.ups.com/track?tracknum=123456789Tracking URL phone_numberstring +1-800-123-4567Contact phone number
Parameter Type Example Description srcstring https://example.com/product-image.jpgImage URL widthint32 800Image width in pixels heightint32 800Image height in pixels altstring Product imageImage alt text
Field Type Example Description codestring InvalidParameterError http message messagestring `` Error message
