The Item Lead Time object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

item_code string
item_name string
buffer_time integer
no_of_shift integer

Default: 1

manufacturing_time_in_mins integer
total_workstation_time integer
daily_yield number

Default: 90

capacity_per_day integer
no_of_units_produced integer
purchase_time integer
shift_time_in_hours integer
no_of_workstations integer
stock_uom string
The Item Lead Time object 
{
  "id": "item-lead-time_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "item_code": "item_code_example",
  "item_name": "item_name_example",
  "buffer_time": 0,
  "no_of_shift": 1,
  "manufacturing_time_in_mins": 0,
  "total_workstation_time": 0,
  "daily_yield": 90,
  "capacity_per_day": 0,
  "no_of_units_produced": 0,
  "purchase_time": 0,
  "shift_time_in_hours": 0,
  "no_of_workstations": 0,
  "stock_uom": "stock_uom_example"
}
GET /api/stock/item-lead-time/{id}

Retrieve a item lead time

Retrieves the details of an existing item lead time. Supply the unique item lead time ID that was returned from a previous request.

Path parameters

id string required

The identifier of the item lead time to retrieve.

Returns

Returns the item lead time object if a valid identifier was provided.

GET /api/stock/item-lead-time/{id} 
curl https://api.overplane.dev/api/stock/item-lead-time/item-lead-time_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "item-lead-time_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "item_code": "item_code_example",
  "item_name": "item_name_example",
  "buffer_time": 0,
  "no_of_shift": 1,
  "manufacturing_time_in_mins": 0,
  "total_workstation_time": 0,
  "daily_yield": 90,
  "capacity_per_day": 0,
  "no_of_units_produced": 0,
  "purchase_time": 0,
  "shift_time_in_hours": 0,
  "no_of_workstations": 0,
  "stock_uom": "stock_uom_example"
}
GET /api/stock/item-lead-time

List all item lead times

Returns a list of item lead times. The results are sorted by creation date, with the most recently created appearing first.

Query parameters

limit integer

Maximum number of objects to return. Default: 20.

offset integer

Number of objects to skip for pagination. Default: 0.

Returns

A paginated list of item lead time objects.

GET /api/stock/item-lead-time 
curl https://api.overplane.dev/api/stock/item-lead-time \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "item-lead-time_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "item_code": "item_code_example",
      "item_name": "item_name_example",
      "buffer_time": 0,
      "no_of_shift": 1,
      "manufacturing_time_in_mins": 0,
      "total_workstation_time": 0,
      "daily_yield": 90,
      "capacity_per_day": 0,
      "no_of_units_produced": 0,
      "purchase_time": 0,
      "shift_time_in_hours": 0,
      "no_of_workstations": 0,
      "stock_uom": "stock_uom_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/stock/item-lead-time

Create a item lead time

Creates a new item lead time object.

Body parameters

item_code string
item_name string
buffer_time integer
no_of_shift integer

Default: 1

manufacturing_time_in_mins integer
total_workstation_time integer
daily_yield number

Default: 90

capacity_per_day integer
no_of_units_produced integer
purchase_time integer
shift_time_in_hours integer
no_of_workstations integer
stock_uom string

Returns

Returns the newly created item lead time object if the call succeeded.

POST /api/stock/item-lead-time 
curl https://api.overplane.dev/api/stock/item-lead-time \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json"
Response 
{
  "id": "item-lead-time_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "item_code": "item_code_example",
  "item_name": "item_name_example",
  "buffer_time": 0,
  "no_of_shift": 1,
  "manufacturing_time_in_mins": 0,
  "total_workstation_time": 0,
  "daily_yield": 90,
  "capacity_per_day": 0,
  "no_of_units_produced": 0,
  "purchase_time": 0,
  "shift_time_in_hours": 0,
  "no_of_workstations": 0,
  "stock_uom": "stock_uom_example"
}
PATCH /api/stock/item-lead-time/{id}

Update a item lead time

Updates the specified item lead time by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the item lead time to update.

Body parameters

item_code string
item_name string
buffer_time integer
no_of_shift integer

Default: 1

manufacturing_time_in_mins integer
total_workstation_time integer
daily_yield number

Default: 90

capacity_per_day integer
no_of_units_produced integer
purchase_time integer
shift_time_in_hours integer
no_of_workstations integer
stock_uom string

Returns

Returns the updated item lead time object.

PATCH /api/stock/item-lead-time/{id} 
curl https://api.overplane.dev/api/stock/item-lead-time/item-lead-time_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"item_code":"item_code_example","item_name":"item_name_example"}'
Response 
{
  "id": "item-lead-time_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "item_code": "item_code_example",
  "item_name": "item_name_example",
  "buffer_time": 0,
  "no_of_shift": 1,
  "manufacturing_time_in_mins": 0,
  "total_workstation_time": 0,
  "daily_yield": 90,
  "capacity_per_day": 0,
  "no_of_units_produced": 0,
  "purchase_time": 0,
  "shift_time_in_hours": 0,
  "no_of_workstations": 0,
  "stock_uom": "stock_uom_example"
}
DELETE /api/stock/item-lead-time/{id}

Delete a item lead time

Permanently deletes a item lead time. This cannot be undone.

Path parameters

id string required

The identifier of the item lead time to delete.

Returns

Returns a confirmation that the item lead time has been deleted.

DELETE /api/stock/item-lead-time/{id} 
curl https://api.overplane.dev/api/stock/item-lead-time/item-lead-time_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "item-lead-time_abc123",
  "deleted": true
}