🔒 The Cancel Fulfillment API cancels a specific fulfillment for an order. This action marks the fulfillment as canceled, stopping any further processing or shipping operations.
This API is especially useful for:
Canceling shipments or fulfillments that are no longer needed.
Managing order updates during the fulfillment process.
Ensuring inventory or shipping workflows are correctly adjusted.
📘 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.
📘 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
