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

new_item_code string required
description string
disabled boolean

Default: false

The Product Bundle object 
{
  "id": "product-bundle_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "new_item_code": "new_item_code_example",
  "description": "description_example",
  "disabled": false
}
GET /api/crm/product-bundle/{id}

Retrieve a product bundle

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

Path parameters

id string required

The identifier of the product bundle to retrieve.

Returns

Returns the product bundle object if a valid identifier was provided.

GET /api/crm/product-bundle/{id} 
curl https://api.overplane.dev/api/crm/product-bundle/product-bundle_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "product-bundle_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "new_item_code": "new_item_code_example",
  "description": "description_example",
  "disabled": false
}
GET /api/crm/product-bundle

List all product bundles

Returns a list of product bundles. 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 product bundle objects.

GET /api/crm/product-bundle 
curl https://api.overplane.dev/api/crm/product-bundle \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "product-bundle_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "new_item_code": "new_item_code_example",
      "description": "description_example",
      "disabled": false
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/crm/product-bundle

Create a product bundle

Creates a new product bundle object.

Body parameters

new_item_code string required
description string
disabled boolean

Default: false

Returns

Returns the newly created product bundle object if the call succeeded.

POST /api/crm/product-bundle 
curl https://api.overplane.dev/api/crm/product-bundle \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"new_item_code":"new_item_code_example"}'
Response 
{
  "id": "product-bundle_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "new_item_code": "new_item_code_example",
  "description": "description_example",
  "disabled": false
}
PATCH /api/crm/product-bundle/{id}

Update a product bundle

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

Body parameters

new_item_code string
description string
disabled boolean

Default: false

Returns

Returns the updated product bundle object.

PATCH /api/crm/product-bundle/{id} 
curl https://api.overplane.dev/api/crm/product-bundle/product-bundle_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"new_item_code":"new_item_code_example","description":"description_example"}'
Response 
{
  "id": "product-bundle_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "new_item_code": "new_item_code_example",
  "description": "description_example",
  "disabled": false
}
DELETE /api/crm/product-bundle/{id}

Delete a product bundle

Permanently deletes a product bundle. This cannot be undone.

Path parameters

id string required

The identifier of the product bundle to delete.

Returns

Returns a confirmation that the product bundle has been deleted.

DELETE /api/crm/product-bundle/{id} 
curl https://api.overplane.dev/api/crm/product-bundle/product-bundle_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "product-bundle_abc123",
  "deleted": true
}

Line items

Child objects that belong to this product bundle. These are accessed via the parent's ID.

Product Bundle Item

Attributes

idx integer
product_bundle_id string required
item_code string required
qty number required
description string
rate number
uom string

Endpoints

GET /api/crm/product-bundle-item?parent_id={id}
POST /api/crm/product-bundle-item
PATCH /api/crm/product-bundle-item/{id}
DELETE /api/crm/product-bundle-item/{id}
POST /api/crm/product-bundle-item/reorder
Product Bundle Item object 
{
  "id": "product-bundle-item_abc123",
  "idx": 1,
  "product_bundle_id": "product_bundle_id_example",
  "item_code": "item_code_example",
  "qty": 0,
  "description": "description_example",
  "rate": 0,
  "uom": "uom_example"
}