The Pricing Rule Item Code object

Attributes

id string

Unique identifier for the object.

idx integer
parent_id string required
parent_type string required
item_code string
uom string
The Pricing Rule Item Code object 
{
  "id": "pricing-rule-item-code_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "item_code": "item_code_example",
  "uom": "uom_example"
}
GET /api/accounts/pricing-rule-item-code?parent_id={id}

List pricing rule item codes by parent

Returns all pricing rule item codes 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 item code objects belonging to the parent.

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

Create a pricing rule item code

Creates a new pricing rule item code object.

Body parameters

idx integer
parent_id string required
parent_type string required
item_code string
uom string

Returns

Returns the newly created pricing rule item code object if the call succeeded.

POST /api/accounts/pricing-rule-item-code 
curl https://api.overplane.dev/api/accounts/pricing-rule-item-code \
  -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-item-code_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "item_code": "item_code_example",
  "uom": "uom_example"
}
PATCH /api/accounts/pricing-rule-item-code/{id}

Update a pricing rule item code

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

Body parameters

idx integer
parent_id string
parent_type string
item_code string
uom string

Returns

Returns the updated pricing rule item code object.

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

Delete a pricing rule item code

Permanently deletes a pricing rule item code. This cannot be undone.

Path parameters

id string required

The identifier of the pricing rule item code to delete.

Returns

Returns a confirmation that the pricing rule item code has been deleted.

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

Reorder pricing rule item codes

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

Returns

Returns the reordered list.

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