Marks items in a fulfillment order as fulfilled and creates a shipment.
Only items in pending status (open or allocated) can be fulfilled:
open - Item awaiting allocationallocated - Item assigned to a locationfulfilled - Already fulfilledcancelled - Cannot be fulfilledclosed - Cannot be fulfilledWhen you fulfill an order:
skip_shipping=true)fulfilled with a unique fulfillment IDYou must provide line_items array specifying which items to fulfill:
id matching an order line itemquantity to fulfill (must be ≤ pending quantity)Control shipment creation with query parameters:
create_draft_shipment=true: Creates a draft shipment for review before carrier bookingskip_shipping=true: Fulfills without creating any shipment (items auto-close)If inventory management is enabled with stock_reduction_timing = ON_ORDER_FULFILLED:
on_hand is reduced by the fulfilled quantityreserved is reduced by the fulfilled quantityIf shipping is not required (or skip_shipping=true), items are automatically set to closed status.
Fulfillment order fulfilled successfully.
Invalid request or fulfillment not possible.
Order or fulfillment order not found.
{- "partner_fulfillment_reference": "string",
- "line_items": [
- {
- "line_item_id": "string",
- "quantity": 0
}
], - "carrier_account": {
- "carrier": "string",
- "carrier_account_id": "string"
}, - "parcels": [
- {
- "length": 0,
- "width": 0,
- "height": 0,
- "dimension_unit": "cm",
- "weight": 0,
- "weight_unit": "kg",
- "description": "string"
}
], - "delivery": {
- "delivery_type": "string",
- "time_slot": {
- "date": "2019-08-24",
- "from": "string",
- "to": "string"
}, - "instructions": "string"
}, - "payment": {
- "payment_mode": "prepaid",
- "pending_amount": 0,
- "currency": "string"
}, - "pre_booking_info": {
- "input_carrier": "string",
- "carrier_tracking_no": "string",
- "awb_pdf_link": "string"
}
}{- "tenant": "string",
- "order_id": "string",
- "merchant": "string",
- "partner_order_reference": "string",
- "language": "string",
- "order_date": "2019-08-24T14:15:22Z",
- "sales_channel": "string",
- "creation_source": {
- "source": "string",
- "user_id": "string",
- "ip_address": "string"
}, - "update_source": {
- "source": "string",
- "user_id": "string",
- "ip_address": "string"
}, - "carriyo_metadata": [
- {
- "key": "string",
- "value": "string"
}
], - "status": "open",
- "auto_allocation_failed": true,
- "cancellation_reason": "CUSTOMER_CANCELLATION",
- "shipping_address": {
- "name": "string",
- "company": "string",
- "email": "user@example.com",
- "phone": "string",
- "alternate_phone": "string",
- "address1": "string",
- "address2": "string",
- "city": "string",
- "state": "string",
- "postcode": "string",
- "country": "string",
- "coords": "string",
- "what3words": "string"
}, - "billing_address": {
- "name": "string",
- "company": "string",
- "email": "user@example.com",
- "phone": "string",
- "alternate_phone": "string",
- "address1": "string",
- "address2": "string",
- "city": "string",
- "state": "string",
- "postcode": "string",
- "country": "string",
- "coords": "string",
- "what3words": "string"
}, - "customer": {
- "name": "string",
- "company": "string",
- "email": "user@example.com",
- "phone": "string",
- "alternate_phone": "string",
- "address1": "string",
- "address2": "string",
- "city": "string",
- "state": "string",
- "postcode": "string",
- "country": "string",
- "coords": "string",
- "what3words": "string"
}, - "payment": {
- "payment_mode": "prepaid",
- "pending_amount": 0,
- "currency": "string"
}, - "redacted": true,
- "taxes_included": true,
- "duties_included": true,
- "discount_applications": [
- {
- "code": "string",
- "type": "string",
- "value": 0,
- "description": "string"
}
], - "line_items": [
- {
- "line_item_id": "string",
- "sku": "string",
- "product_id": "string",
- "name": "string",
- "description": "string",
- "quantity": 0,
- "price": 0,
- "currency": "string",
- "weight": 0,
- "weight_unit": "kg",
- "image_url": "string",
- "properties": {
- "property1": "string",
- "property2": "string"
}
}
], - "fulfillment_orders": [
- {
- "fulfillment_order_id": "string",
- "partner_fulfillment_order_reference": "string",
- "location_id": "string",
- "delivery": {
- "delivery_type": "string",
- "time_slot": {
- "date": "2019-08-24",
- "from": "string",
- "to": "string"
}, - "instructions": "string"
}, - "line_items": [
- {
- "line_item_id": "string",
- "quantity": 0,
- "status": "open",
- "fulfillment_id": "string",
- "shipment_ids": [
- "string"
]
}
], - "carriyo_metadata": [
- {
- "key": "string",
- "value": "string"
}
]
}
], - "shipping_lines": [
- {
- "code": "string",
- "title": "string",
- "price": 0,
- "currency": "string"
}
], - "error_details": [
- {
- "code": "string",
- "message": "string",
- "field": "string"
}
], - "creation_date": "2019-08-24T14:15:22Z",
- "update_date": "2019-08-24T14:15:22Z"
}