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

brand string required
description string
image string
The Brand object 
{
  "id": "brand_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "brand": "brand_example",
  "description": "description_example",
  "image": "image_example"
}
GET /api/setup/brand/{id}

Retrieve a brand

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

Path parameters

id string required

The identifier of the brand to retrieve.

Returns

Returns the brand object if a valid identifier was provided.

GET /api/setup/brand/{id} 
curl https://api.overplane.dev/api/setup/brand/brand_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "brand_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "brand": "brand_example",
  "description": "description_example",
  "image": "image_example"
}
GET /api/setup/brand

List all brands

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

GET /api/setup/brand 
curl https://api.overplane.dev/api/setup/brand \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "brand_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "brand": "brand_example",
      "description": "description_example",
      "image": "image_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/setup/brand

Create a brand

Creates a new brand object.

Body parameters

brand string required
description string
image string

Returns

Returns the newly created brand object if the call succeeded.

POST /api/setup/brand 
curl https://api.overplane.dev/api/setup/brand \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"brand":"brand_example"}'
Response 
{
  "id": "brand_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "brand": "brand_example",
  "description": "description_example",
  "image": "image_example"
}
PATCH /api/setup/brand/{id}

Update a brand

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

Body parameters

brand string
description string
image string

Returns

Returns the updated brand object.

PATCH /api/setup/brand/{id} 
curl https://api.overplane.dev/api/setup/brand/brand_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"brand":"brand_example","description":"description_example"}'
Response 
{
  "id": "brand_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "brand": "brand_example",
  "description": "description_example",
  "image": "image_example"
}
DELETE /api/setup/brand/{id}

Delete a brand

Permanently deletes a brand. This cannot be undone.

Path parameters

id string required

The identifier of the brand to delete.

Returns

Returns a confirmation that the brand has been deleted.

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