The Pricing Rule Brand object

Attributes

id string

Unique identifier for the object.

idx integer
parent_id string required
parent_type string required
brand string
uom string
The Pricing Rule Brand object 
{
  "id": "pricing-rule-brand_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "brand": "brand_example",
  "uom": "uom_example"
}
GET /api/accounts/pricing-rule-brand?parent_id={id}

List pricing rule brands by parent

Returns all pricing rule brands belonging to the specified parent.

Query parameters

parent_id string required

The ID of the parent to list children for.

Returns

A list of pricing rule brand objects belonging to the parent.

GET /api/accounts/pricing-rule-brand?parent_id={id} 
curl https://api.overplane.dev/api/accounts/pricing-rule-brand?parent_id=parent_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "pricing-rule-brand_abc123",
      "idx": 1,
      "parent_id": null,
      "parent_type": "parent_type_example",
      "brand": "brand_example",
      "uom": "uom_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/accounts/pricing-rule-brand

Create a pricing rule brand

Creates a new pricing rule brand object.

Body parameters

idx integer
parent_id string required
parent_type string required
brand string
uom string

Returns

Returns the newly created pricing rule brand object if the call succeeded.

POST /api/accounts/pricing-rule-brand 
curl https://api.overplane.dev/api/accounts/pricing-rule-brand \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"parent_id":null,"parent_type":"parent_type_example"}'
Response 
{
  "id": "pricing-rule-brand_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "brand": "brand_example",
  "uom": "uom_example"
}
PATCH /api/accounts/pricing-rule-brand/{id}

Update a pricing rule brand

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

Body parameters

idx integer
parent_id string
parent_type string
brand string
uom string

Returns

Returns the updated pricing rule brand object.

PATCH /api/accounts/pricing-rule-brand/{id} 
curl https://api.overplane.dev/api/accounts/pricing-rule-brand/pricing-rule-brand_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"idx":1,"parent_id":null}'
Response 
{
  "id": "pricing-rule-brand_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "brand": "brand_example",
  "uom": "uom_example"
}
DELETE /api/accounts/pricing-rule-brand/{id}

Delete a pricing rule brand

Permanently deletes a pricing rule brand. This cannot be undone.

Path parameters

id string required

The identifier of the pricing rule brand to delete.

Returns

Returns a confirmation that the pricing rule brand has been deleted.

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

Reorder pricing rule brands

Updates the sort order of pricing rule brands within their parent by setting new index values.

Returns

Returns the reordered list.

POST /api/accounts/pricing-rule-brand/reorder 
curl https://api.overplane.dev/api/accounts/pricing-rule-brand/reorder \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "pricing-rule-brand_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "brand": "brand_example",
  "uom": "uom_example"
}