Get Item Fulfillment List: /item-fulfillments
Purpose
Retrieves a list of item fulfillments along with associated details such as order IDs, invoice IDs, tracking numbers, item information, and fulfillment status. This helps in tracking and managing item shipments and inventory.
Use Case
A logistics or inventory manager needs to track the fulfillment status of orders, including shipped and closed items. This endpoint helps monitor the progress of shipments, quantities fulfilled, and items left to be fulfilled.
Path Parameters
| Name | Type | Description |
|---|---|---|
| uuid | string | Unique identifier of the organization |
Query Parameters
| Name | Type | Description |
|---|---|---|
| order_by | string | Sort the results by a specific field (e.g., "date") |
| direction | string | Sort direction ("asc" for ascending, "desc" for descending) |
| limit | integer | Maximum number of records to return (default: 20) |
| offset | integer | Number of records to skip before starting to return results |
Request Body
No request body required for this endpoint.
Response
Returns a list of item fulfillments, each including status, order ID, invoice ID, tracking number, and the items that are being fulfilled. Fulfillment details, including the quantity fulfilled and remaining, are also provided. Pagination details are included for navigating through large sets of data.
{
"item-fulfillments": [
{
"status": "CLOSED",
"date": "FULFILLMENT_DATE",
"id": "FULFILLMENT_ID",
"order_id": "ORDER_ID",
"invoice_id": "INVOICE_ID",
"tracking_number": "TRACKING_NUMBER",
"note": "FULFILLMENT_NOTE",
"fulfillments": [
{
"fulfilled_quantity": "FULFILLED_QUANTITY",
"fulfillment_left": "FULFILLMENT_LEFT",
"item_id": "ITEM_ID",
"item_name": "ITEM_NAME",
"line_uuid": "LINE_UUID",
"uom": "UNIT_OF_MEASURE",
"warehouse": "WAREHOUSE_NAME"
}
],
"created_by": "CREATED_BY",
"created_on": "CREATED_ON_TIMESTAMP",
"last_updated_by": "LAST_UPDATED_BY",
"last_updated_on": "LAST_UPDATED_ON_TIMESTAMP",
"uuid": "FULFILLMENT_UUID",
"version": "1"
}
],
"pagination": {
"records": "TOTAL_RECORDS",
"limit": "LIMIT",
"offset": "OFFSET",
"previous_page": "PREVIOUS_PAGE_URL",
"next_page": "NEXT_PAGE_URL"
}
}
| Field | Type | Description |
|---|---|---|
| item-fulfillments | array | List of item fulfillment records |
| item-fulfillments[].status | string | Status of the fulfillment (e.g., "CLOSED") |
| item-fulfillments[].id | string | Unique identifier for the fulfillment |
| item-fulfillments[].order_id | string | Associated order ID |
| item-fulfillments[].invoice_id | string | Associated invoice ID |
| item-fulfillments[].tracking_number | string | Tracking number for the fulfillment |
| item-fulfillments[].note | string | Optional note for the fulfillment |
| item-fulfillments[].fulfillments | array | Array of items in this fulfillment |
| item-fulfillments[].fulfillments[].fulfilled_quantity | decimal | Quantity of the item that has been fulfilled |
| item-fulfillments[].fulfillments[].fulfillment_left | decimal | Quantity of the item that is left to be fulfilled |
| item-fulfillments[].fulfillments[].item_id | string | Item identifier |
| item-fulfillments[].fulfillments[].item_name | string | Name of the item being fulfilled |
| item-fulfillments[].fulfillments[].line_uuid | string | Line UUID associated with the item |
| item-fulfillments[].fulfillments[].uom | string | Unit of measure for the item |
| item-fulfillments[].fulfillments[].warehouse | string | Warehouse name where the item is located |
| item-fulfillments[].created_by | string | User who created the fulfillment |
| item-fulfillments[].created_on | string | Timestamp when the fulfillment was created |
| item-fulfillments[].last_updated_by | string | User who last updated the fulfillment |
| item-fulfillments[].last_updated_on | string | Timestamp when the fulfillment was last updated |
| item-fulfillments[].uuid | string | Unique identifier for the fulfillment |
| item-fulfillments[].version | integer | Version of the fulfillment |
| pagination | object | Pagination metadata |
| pagination.records | integer | Total records available |
| pagination.limit | integer | Number of records per page |
| pagination.offset | integer | The offset of the results |
| pagination.previous_page | string | URL to fetch the previous page of results |
| pagination.next_page | string | URL to fetch the next page of results |
Get Item Fulfillment Details: /item-fulfillments/{id}
Purpose
Retrieves the details of a specific item fulfillment, including fulfillment status, order ID, invoice ID, tracking number, item details, and quantities fulfilled or remaining.
Use Case
A logistics or inventory manager needs to retrieve detailed information about a specific item fulfillment to verify the status, quantities, and related order or invoice details. This endpoint helps in managing fulfilled or pending items for tracking and auditing purposes.
Path Parameters
| Name | Type | Description |
|---|---|---|
| id | string | Unique identifier for the item fulfillment |
Query Parameters
No query parameters required for this endpoint.
Request Body
No request body required for this endpoint.
Response
Returns detailed information about a specific item fulfillment, including the status, order details, tracking information, item quantities fulfilled, and the remaining fulfillment quantity. The response helps in tracking and auditing item deliveries.
{
"item_fulfillment": {
"status": "CLOSED",
"date": "FULFILLMENT_DATE",
"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": "FULFILLMENT_QUANTITY",
"fulfillment_left": "FULFILLMENT_LEFT",
"uuid": "FULFILLMENT_ITEM_UUID"
}
],
"created_by": "CREATED_BY",
"created_on": "CREATED_ON_TIMESTAMP",
"last_updated_by": "LAST_UPDATED_BY",
"last_updated_on": "LAST_UPDATED_ON_TIMESTAMP",
"uuid": "FULFILLMENT_UUID",
"version": "1"
}
}
| Field | Type | Description |
|---|---|---|
| item_fulfillment | object | Details of the item fulfillment |
| item_fulfillment.status | string | Status of the fulfillment (e.g., "CLOSED") |
| item_fulfillment.date | string | Date of the fulfillment (ISO 8601 format) |
| item_fulfillment.id | string | Unique identifier for the fulfillment |
| item_fulfillment.order_id | string | Associated order ID |
| item_fulfillment.invoice_id | string | Associated invoice ID |
| item_fulfillment.tracking_number | string | Tracking number for the fulfillment |
| item_fulfillment.note | string | Optional note for the fulfillment |
| item_fulfillment.fulfillments | array | List of items and their fulfillment details |
| item_fulfillment.fulfillments[].item_uuid | string | Item UUID |
| item_fulfillment.fulfillments[].item_id | string | Item identifier |
| item_fulfillment.fulfillments[].uom | string | Unit of measure for the item |
| item_fulfillment.fulfillments[].warehouse | string | Warehouse where the item is located |
| item_fulfillment.fulfillments[].fulfillment_quantity | decimal | Quantity fulfilled |
| item_fulfillment.fulfillments[].fulfillment_left | decimal | Quantity remaining to be fulfilled |
| item_fulfillment.fulfillments[].uuid | string | UUID for the fulfillment line |
| item_fulfillment.created_by | string | User who created the fulfillment |
| item_fulfillment.created_on | string | Timestamp of when the fulfillment was created |
| item_fulfillment.last_updated_by | string | User who last updated the fulfillment |
| item_fulfillment.last_updated_on | string | Timestamp of the last update |
| item_fulfillment.uuid | string | UUID of the item fulfillment |
| item_fulfillment.version | integer | Version of the fulfillment |
Get Item Fulfillments for Invoice:/invoices/{id}/item-fulfillments
Purpose
Retrieves item fulfillment details associated with a specific invoice, including the status, order ID, tracking number, item quantities fulfilled, and remaining quantities.
Use Case
An accountant or inventory manager needs to retrieve all item fulfillments related to a particular invoice. This endpoint helps track the fulfillment status, quantities, and other details associated with each item in the invoice for better order management.
Path Parameters
| Name | Type | Description |
|---|---|---|
| id | string | Unique identifier for the invoice |
Query Parameters
| Name | Type | Description |
|---|---|---|
| order_by | string | Field to order results (optional) |
| direction | string | Direction of sorting, either "asc" or "desc" (optional) |
| limit | integer | Number of records to return (default: 20) |
| offset | integer | Offset for pagination (default: 0) |
Request Body
No request body required for this endpoint.
Response
Returns a list of item fulfillments associated with the specified invoice, including item details like quantities, fulfillment status, tracking information, and order details. The response supports pagination for large datasets.
{
"invoice": {
"item_fulfillments": [
{
"status": "CLOSED",
"date": "FULFILLMENT_DATE",
"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": "FULFILLMENT_QUANTITY",
"fulfillment_left": "FULFILLMENT_LEFT",
"uuid": "FULFILLMENT_ITEM_UUID"
}
],
"created_by": "CREATED_BY",
"created_on": "CREATED_ON_TIMESTAMP",
"last_updated_by": "LAST_UPDATED_BY",
"last_updated_on": "LAST_UPDATED_ON_TIMESTAMP",
"uuid": "FULFILLMENT_UUID",
"version": "1"
}
],
"pagination": {
"records": 1,
"limit": 20,
"offset": 0,
"previous_page": "",
"next_page": "NULL"
}
}
}
| Field | Type | Description |
|---|---|---|
| invoice | object | Invoice details containing item fulfillments |
| invoice.item_fulfillments | array | List of item fulfillments associated with the invoice |
| invoice.item_fulfillments[].status | string | Fulfillment status (e.g., "CLOSED") |
| invoice.item_fulfillments[].date | string | Date of fulfillment (ISO 8601 format) |
| invoice.item_fulfillments[].id | string | Unique identifier for the fulfillment |
| invoice.item_fulfillments[].order_id | string | Associated order ID |
| invoice.item_fulfillments[].invoice_id | string | Associated invoice ID |
| invoice.item_fulfillments[].tracking_number | string | Tracking number for the fulfillment |
| invoice.item_fulfillments[].note | string | Optional note for the fulfillment |
| invoice.item_fulfillments[].fulfillments | array | List of item fulfillments within the fulfillment |
| invoice.item_fulfillments[].fulfillments[].item_uuid | string | Item UUID |
| invoice.item_fulfillments[].fulfillments[].item_id | string | Item identifier |
| invoice.item_fulfillments[].fulfillments[].uom | string | Unit of measure for the item |
| invoice.item_fulfillments[].fulfillments[].warehouse | string | Warehouse where the item is stored |
| invoice.item_fulfillments[].fulfillments[].fulfillment_quantity | decimal | Quantity fulfilled |
| invoice.item_fulfillments[].fulfillments[].fulfillment_left | decimal | Quantity left to be fulfilled |
| invoice.item_fulfillments[].fulfillments[].uuid | string | UUID for the fulfillment line |
| invoice.created_by | string | User who created the invoice |
| invoice.created_on | string | Timestamp when the invoice was created |
| invoice.last_updated_by | string | User who last updated the invoice |
| invoice.last_updated_on | string | Timestamp of last update |
| invoice.uuid | string | UUID of the invoice |
| invoice.version | integer | Version of the invoice |
| pagination | object | Pagination metadata |
| pagination.records | integer | Total records available |
| pagination.limit | integer | Maximum records per page |
| pagination.offset | integer | Current offset index |
| pagination.previous_page | string | URL to fetch the previous page of results |
| pagination.next_page | string | URL to fetch the next page of results |
Get Specific Item Fulfillment for Invoice: /invoices/{id}/item-fulfillments/{id}
Purpose
Retrieves detailed information about a specific item fulfillment for a given invoice, including fulfillment status, order and tracking details, and the items involved.
Use Case
A logistics or fulfillment team needs to view detailed information on a specific item fulfillment, including tracking numbers, item quantities fulfilled, and remaining quantities for precise tracking and delivery.
Path Parameters
| Name | Type | Description |
|---|---|---|
| id | string | Unique identifier for the invoice |
| id | string | Unique identifier for the item fulfillment |
Query Parameters
No query parameters required for this endpoint.
Request Body
No request body required for this endpoint.
Response
Returns the specific item fulfillment for the provided invoice and item fulfillment IDs, including details such as fulfillment status, order ID, tracking number, quantities, and timestamps. The response also includes the metadata for the fulfillment, such as created by, created on, and updated details.
{
"invoice": {
"item_fulfillment": {
"status": "FULFILLMENT_STATUS",
"date": "FULFILLMENT_DATE",
"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": "FULFILLMENT_QUANTITY",
"fulfillment_left": "FULFILLMENT_LEFT",
"uuid": "FULFILLMENT_ITEM_UUID"
}
],
"created_by": "CREATED_BY",
"created_on": "CREATED_ON_TIMESTAMP",
"last_updated_by": "LAST_UPDATED_BY",
"last_updated_on": "LAST_UPDATED_ON_TIMESTAMP",
"uuid": "FULFILLMENT_UUID",
"version": "1"
}
}
}
| Field | Type | Description |
|---|---|---|
| invoice | object | Invoice details containing item fulfillment |
| invoice.item_fulfillment | object | Item fulfillment object |
| invoice.item_fulfillment.status | string | Status of the fulfillment (e.g., "CLOSED") |
| invoice.item_fulfillment.date | string | Date of the item fulfillment (ISO 8601 format) |
| invoice.item_fulfillment.id | string | Fulfillment identifier |
| invoice.item_fulfillment.order_id | string | Associated order ID |
| invoice.item_fulfillment.invoice_id | string | Associated invoice ID |
| invoice.item_fulfillment.tracking_number | string | Tracking number for the fulfillment |
| invoice.item_fulfillment.note | string | Optional note for the fulfillment |
| invoice.item_fulfillment.fulfillments | array | List of item fulfillments within the fulfillment |
| invoice.item_fulfillment.fulfillments[].item_uuid | string | Item UUID |
| invoice.item_fulfillment.fulfillments[].item_id | string | Item identifier |
| invoice.item_fulfillment.fulfillments[].uom | string | Unit of measure for the item |
| invoice.item_fulfillment.fulfillments[].warehouse | string | Warehouse where the item is stored |
| invoice.item_fulfillment.fulfillments[].fulfillment_quantity | decimal | Quantity fulfilled |
| invoice.item_fulfillment.fulfillments[].fulfillment_left | decimal | Quantity left to be fulfilled |
| invoice.item_fulfillment.fulfillments[].uuid | string | UUID for the fulfillment item |
| invoice.created_by | string | User who created the item fulfillment |
| invoice.created_on | string | Timestamp when the item fulfillment was created |
| invoice.last_updated_by | string | User who last updated the item fulfillment |
| invoice.last_updated_on | string | Timestamp of the last update |
| invoice.uuid | string | UUID of the item fulfillment |
| invoice.version | integer | Version of the item fulfillment |