The Item Manufacturer 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.

manufacturer string required
manufacturer_part_no string required
item_code string required
item_name string
description string
is_default boolean

Default: false

The Item Manufacturer object 
{
  "id": "item-manufacturer_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "manufacturer": "manufacturer_example",
  "manufacturer_part_no": "manufacturer_part_no_example",
  "item_code": "item_code_example",
  "item_name": "item_name_example",
  "description": "description_example",
  "is_default": false
}
GET /api/stock/item-manufacturer/{id}

Retrieve a item manufacturer

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

Path parameters

id string required

The identifier of the item manufacturer to retrieve.

Returns

Returns the item manufacturer object if a valid identifier was provided.

GET /api/stock/item-manufacturer/{id} 
curl https://api.overplane.dev/api/stock/item-manufacturer/item-manufacturer_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "item-manufacturer_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "manufacturer": "manufacturer_example",
  "manufacturer_part_no": "manufacturer_part_no_example",
  "item_code": "item_code_example",
  "item_name": "item_name_example",
  "description": "description_example",
  "is_default": false
}
GET /api/stock/item-manufacturer

List all item manufacturers

Returns a list of item manufacturers. 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 manufacturer objects.

GET /api/stock/item-manufacturer 
curl https://api.overplane.dev/api/stock/item-manufacturer \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "item-manufacturer_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "manufacturer": "manufacturer_example",
      "manufacturer_part_no": "manufacturer_part_no_example",
      "item_code": "item_code_example",
      "item_name": "item_name_example",
      "description": "description_example",
      "is_default": false
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/stock/item-manufacturer

Create a item manufacturer

Creates a new item manufacturer object.

Body parameters

manufacturer string required
manufacturer_part_no string required
item_code string required
item_name string
description string
is_default boolean

Default: false

Returns

Returns the newly created item manufacturer object if the call succeeded.

POST /api/stock/item-manufacturer 
curl https://api.overplane.dev/api/stock/item-manufacturer \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"manufacturer":"manufacturer_example","manufacturer_part_no":"manufacturer_part_no_example","item_code":"item_code_example"}'
Response 
{
  "id": "item-manufacturer_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "manufacturer": "manufacturer_example",
  "manufacturer_part_no": "manufacturer_part_no_example",
  "item_code": "item_code_example",
  "item_name": "item_name_example",
  "description": "description_example",
  "is_default": false
}
PATCH /api/stock/item-manufacturer/{id}

Update a item manufacturer

Updates the specified item manufacturer 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 manufacturer to update.

Body parameters

manufacturer string
manufacturer_part_no string
item_code string
item_name string
description string
is_default boolean

Default: false

Returns

Returns the updated item manufacturer object.

PATCH /api/stock/item-manufacturer/{id} 
curl https://api.overplane.dev/api/stock/item-manufacturer/item-manufacturer_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"manufacturer":"manufacturer_example","manufacturer_part_no":"manufacturer_part_no_example"}'
Response 
{
  "id": "item-manufacturer_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "manufacturer": "manufacturer_example",
  "manufacturer_part_no": "manufacturer_part_no_example",
  "item_code": "item_code_example",
  "item_name": "item_name_example",
  "description": "description_example",
  "is_default": false
}
DELETE /api/stock/item-manufacturer/{id}

Delete a item manufacturer

Permanently deletes a item manufacturer. This cannot be undone.

Path parameters

id string required

The identifier of the item manufacturer to delete.

Returns

Returns a confirmation that the item manufacturer has been deleted.

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