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

short_name string required
full_name string
website string
country string
logo string
notes string
The Manufacturer object 
{
  "id": "manufacturer_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "short_name": "short_name_example",
  "full_name": "full_name_example",
  "website": "website_example",
  "country": "country_example",
  "logo": "logo_example",
  "notes": "notes_example"
}
GET /api/stock/manufacturer/{id}

Retrieve a manufacturer

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

Path parameters

id string required

The identifier of the manufacturer to retrieve.

Returns

Returns the manufacturer object if a valid identifier was provided.

GET /api/stock/manufacturer/{id} 
curl https://api.overplane.dev/api/stock/manufacturer/manufacturer_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "manufacturer_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "short_name": "short_name_example",
  "full_name": "full_name_example",
  "website": "website_example",
  "country": "country_example",
  "logo": "logo_example",
  "notes": "notes_example"
}
GET /api/stock/manufacturer

List all manufacturers

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

GET /api/stock/manufacturer 
curl https://api.overplane.dev/api/stock/manufacturer \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "manufacturer_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "short_name": "short_name_example",
      "full_name": "full_name_example",
      "website": "website_example",
      "country": "country_example",
      "logo": "logo_example",
      "notes": "notes_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/stock/manufacturer

Create a manufacturer

Creates a new manufacturer object.

Body parameters

short_name string required
full_name string
website string
country string
logo string
notes string

Returns

Returns the newly created manufacturer object if the call succeeded.

POST /api/stock/manufacturer 
curl https://api.overplane.dev/api/stock/manufacturer \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"short_name":"short_name_example"}'
Response 
{
  "id": "manufacturer_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "short_name": "short_name_example",
  "full_name": "full_name_example",
  "website": "website_example",
  "country": "country_example",
  "logo": "logo_example",
  "notes": "notes_example"
}
PATCH /api/stock/manufacturer/{id}

Update a manufacturer

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

Body parameters

short_name string
full_name string
website string
country string
logo string
notes string

Returns

Returns the updated manufacturer object.

PATCH /api/stock/manufacturer/{id} 
curl https://api.overplane.dev/api/stock/manufacturer/manufacturer_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"short_name":"short_name_example","full_name":"full_name_example"}'
Response 
{
  "id": "manufacturer_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "short_name": "short_name_example",
  "full_name": "full_name_example",
  "website": "website_example",
  "country": "country_example",
  "logo": "logo_example",
  "notes": "notes_example"
}
DELETE /api/stock/manufacturer/{id}

Delete a manufacturer

Permanently deletes a manufacturer. This cannot be undone.

Path parameters

id string required

The identifier of the manufacturer to delete.

Returns

Returns a confirmation that the manufacturer has been deleted.

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