Item Fulfillment PATCH API Documentation

Purpose

This API is used to update an existing item fulfillment record in the system. It allows modifying fulfillment details such as fulfillment date, tracking number, notes, and fulfilled item quantities. This endpoint helps maintain accurate and up-to-date fulfillment records, ensuring that any changes made during or after shipment are reflected correctly in both fulfillment and invoice tracking.

Use Case

This API is typically used when an existing fulfillment record requires modification. For instance, if the tracking number changes, shipment notes are updated, or item fulfillment quantities are adjusted after verification. It is particularly useful for logistics and operations teams to correct fulfillment data, synchronize updates with carrier tracking systems, or confirm final fulfillment details before closing a shipment.

Path Parameters

Parameter	Type	Description
fulfillment_id	String	Unique identifier of the item fulfillment record to be updated.

Query Parameters

This API does not support query parameters.

Request Body

                JSON
              

                      {
    "item_fulfillment": {
        "date": "{{fulfillment_date}}",
        "id": "{{fulfillment_id}}",
        "tracking_number": "{{tracking_number}}",
        "note": "{{fulfillment_note}}",
        "fulfillments": [
            {
                "item_uuid": "{{item_uuid}}",
                "fulfillment_quantity": "{{fulfilled_quantity}}",
                "uuid": "{{fulfillment_line_uuid}}"
            }
        ]
    }
}

                    

Attribute	Type	Description
item_fulfillment	Object	Root object containing updated item fulfillment information.
item_fulfillment.date	String	Updated fulfillment date in YYYY-MM-DD format.
item_fulfillment.id	String	Fulfillment identifier, typically a user-defined or pre-existing ID.
item_fulfillment.tracking_number	String	Updated tracking number for the shipment or delivery.
item_fulfillment.note	String	Additional note or remark about the fulfillment (example: delivery details).
item_fulfillment.fulfillments	Array	List of items with updated fulfillment quantities.
item_fulfillment.fulfillments.item_uuid	String	Unique identifier of the item being fulfilled.
item_fulfillment.fulfillments.fulfillment_quantity	String	Updated quantity of the item fulfilled.
item_fulfillment.fulfillments.uuid	String	Unique identifier for the specific fulfillment line being updated.

Response

On a successful update, the API returns the complete and updated item fulfillment record. This includes all fulfillment details such as status, fulfillment date, identifiers, tracking information, fulfillment line details, and audit metadata like who created or last updated the record. This ensures that all stakeholders and systems referencing this fulfillment record have the latest, most accurate information for operational or reporting purposes.

Response Body

                JSON
              

                      {
    "item_fulfillment": {
        "status": "{{fulfillment_status}}",
        "date": "{{fulfillment_date_time}}",
        "id": "{{fulfillment_id}}",
        "order_id": "{{order_id}}",
        "invoice_id": "{{invoice_id}}",
        "tracking_number": "{{tracking_number}}",
        "note": "{{fulfillment_note}}",
        "fulfillments": [
            {
                "item_uuid": "{{item_uuid}}",
                "item_id": "{{item_id}}",
                "uom": "{{unit_of_measure}}",
                "warehouse": "{{warehouse_name}}",
                "fulfillment_quantity": "{{fulfilled_quantity}}",
                "fulfillment_left": "{{remaining_quantity}}",
                "uuid": "{{fulfillment_line_uuid}}"
            }
        ],
        "created_by": "{{created_by_user}}",
        "created_on": "{{creation_timestamp}}",
        "last_updated_by": "{{last_updated_by_user}}",
        "last_updated_on": "{{last_updated_timestamp}}",
        "uuid": "{{fulfillment_record_uuid}}",
        "version": "{{record_version}}"
    }
}

                    

Attribute	Type	Description
item_fulfillment	Object	Root object containing details of the updated item fulfillment record.
item_fulfillment.status	String	Current status of the fulfillment (example: SHIPPED, PENDING, DELIVERED).
item_fulfillment.date	String	Updated fulfillment date and time in ISO 8601 format.
item_fulfillment.id	String	Unique identifier of the fulfillment record.
item_fulfillment.order_id	String	Identifier of the order linked to this fulfillment record.
item_fulfillment.invoice_id	String	Identifier of the invoice associated with the fulfillment.
item_fulfillment.tracking_number	String	Updated tracking number associated with the shipment.
item_fulfillment.note	String	Updated note or remarks related to the fulfillment.
item_fulfillment.fulfillments	Array	List of updated item fulfillment entries.
item_fulfillment.fulfillments.item_uuid	String	Unique identifier of the fulfilled item.
item_fulfillment.fulfillments.item_id	String	Internal system ID of the fulfilled item.
item_fulfillment.fulfillments.uom	String	Unit of measure used for the fulfillment (if applicable).
item_fulfillment.fulfillments.warehouse	String	Warehouse or storage location used for the fulfillment.
item_fulfillment.fulfillments.fulfillment_quantity	String	Quantity fulfilled in this update.
item_fulfillment.fulfillments.fulfillment_left	String	Remaining quantity left to be fulfilled.
item_fulfillment.fulfillments.uuid	String	Unique identifier for the fulfillment line item.
item_fulfillment.created_by	String	Username or system identifier of the user who originally created the record.
item_fulfillment.created_on	String	Timestamp when the record was first created.
item_fulfillment.last_updated_by	String	Username or system identifier of the user who made the latest update.
item_fulfillment.last_updated_on	String	Timestamp of the latest modification to the record.
item_fulfillment.uuid	String	System-generated unique identifier for the fulfillment record.
item_fulfillment.version	String	Version number of the fulfillment record, incremented after each update.