{"openapi":"3.0.0","info":{"version":"v1","title":"Quoter API","description":"Move faster and sell more hardware, software, and services with Quoter, the all-in-one quoting platform as intuitive as your offerings are complex."},"servers":[{"url":"https://api.scalepad.com/quoter"}],"paths":{"/v1/line-items":{"post":{"description":"Creates a new line item within an existing quote.","tags":["Line Items"],"security":[{"ApiKeyAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LineItemCreateRequest"}}}},"responses":{"201":{"$ref":"#/components/responses/LineItemStatusCode201Create"},"404":{"$ref":"#/components/responses/StatusCode404"}},"summary":"Create Line Item"}},"/v1/quote-templates":{"get":{"description":"Retrieves a paginated list of all Quote Templates. Supports filtering by title and sorting options.","tags":["Quote Templates"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/QuoteTemplateQueryListFilterByTitle"},{"$ref":"#/components/parameters/QuoteTemplateQueryListSort"},{"$ref":"#/components/parameters/QueryListPageSize"},{"$ref":"#/components/parameters/QueryListCursor"}],"responses":{"200":{"$ref":"#/components/responses/QuoteTemplateStatusCode200List"},"404":{"$ref":"#/components/responses/StatusCode404"},"422":{"$ref":"#/components/responses/StatusCode422"}},"summary":"List Quote Templates"}},"/v1/quotes":{"get":{"description":"Retrieves a paginated list of all Quotes. Supports multiple filtering and sorting options.","tags":["Quotes"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/QueryListFilterByExpiredAt"},{"$ref":"#/components/parameters/QueryListFilterByRecordCreatedAt"},{"$ref":"#/components/parameters/QueryListFilterByRecordUpdatedAt"},{"$ref":"#/components/parameters/QueryListFilterWonAt"},{"$ref":"#/components/parameters/QuoteQueryListFilterByClientID"},{"$ref":"#/components/parameters/QuoteQueryListFilterByCustomNumber"},{"$ref":"#/components/parameters/QuoteQueryListFilterByDraft"},{"$ref":"#/components/parameters/QuoteQueryListFilterByEmailStatus"},{"$ref":"#/components/parameters/QuoteQueryListFilterByIDs"},{"$ref":"#/components/parameters/QuoteQueryListFilterByLMInitiativeID"},{"$ref":"#/components/parameters/QuoteQueryListFilterByName"},{"$ref":"#/components/parameters/QuoteQueryListFilterByPrimary"},{"$ref":"#/components/parameters/QuoteQueryListFilterByRecurringInterval"},{"$ref":"#/components/parameters/QuoteQueryListFilterByStage"},{"$ref":"#/components/parameters/QuoteQueryListFilterByUUID"},{"$ref":"#/components/parameters/QuoteQueryListSort"},{"$ref":"#/components/parameters/QueryListPageSize"},{"$ref":"#/components/parameters/QueryListCursor"}],"responses":{"200":{"$ref":"#/components/responses/QuoteStatusCode200List"},"404":{"$ref":"#/components/responses/StatusCode404"},"422":{"$ref":"#/components/responses/StatusCode422"}},"summary":"List Quotes"}},"/v1/categories":{"post":{"summary":"Create Category","description":"Adds a new category to organize items.","tags":["Categories"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/CategoryQueryFields"}],"requestBody":{"required":true,"description":"Request body to create a Category.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryCreateRequest"}}}},"responses":{"201":{"$ref":"#/components/responses/CategoryStatusCode201Created"},"404":{"$ref":"#/components/responses/StatusCode404"}}},"get":{"summary":"List Categories","description":"Retrieves a list of all categories available in the system.","tags":["Categories"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/CategoryQueryFields"},{"$ref":"#/components/parameters/CategoryQueryListSort"},{"$ref":"#/components/parameters/CategoryQueryListFilterByParentCategoryID"},{"$ref":"#/components/parameters/QueryListFilterByName"},{"$ref":"#/components/parameters/QueryListFilterByRecordCreatedAt"},{"$ref":"#/components/parameters/QueryListFilterByRecordUpdatedAt"},{"$ref":"#/components/parameters/QueryListPageSize"},{"$ref":"#/components/parameters/QueryListCursor"}],"responses":{"200":{"$ref":"#/components/responses/CategoryStatusCode200List"},"404":{"$ref":"#/components/responses/StatusCode404"},"422":{"$ref":"#/components/responses/StatusCode422"}}}},"/v1/categories/{id}":{"delete":{"summary":"Delete Category","description":"Removes a category from the system.","tags":["Categories"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"id","in":"path","description":"Category ID","required":true,"schema":{"type":"string"}}],"responses":{"204":{"$ref":"#/components/responses/StatusCode204Deleted"},"404":{"$ref":"#/components/responses/StatusCode404"}}},"get":{"summary":"Fetch Category","description":"Retrieves detailed information about a specific category.","tags":["Categories"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"id","in":"path","description":"Category ID","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/CategoryQueryFields"}],"responses":{"200":{"$ref":"#/components/responses/CategoryStatusCode200"},"404":{"$ref":"#/components/responses/StatusCode404"}}},"patch":{"summary":"Update Category","description":"Modifies the properties or configuration of an existing category.","tags":["Categories"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"id","in":"path","description":"Category ID","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/CategoryQueryFields"}],"requestBody":{"required":true,"description":"Request body to update a Category.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryUpdateRequest"}}}},"responses":{"200":{"$ref":"#/components/responses/CategoryStatusCode200Updated"},"404":{"$ref":"#/components/responses/StatusCode404"}}}},"/v1/item-group-item-assignments":{"post":{"summary":"Create Item Group Assignment","description":"Assigns an item to an item group.","tags":["Item Group Assignments"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ItemGroupAssignmentQueryFields"}],"requestBody":{"required":true,"description":"Request body to create an Item Group Assignment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemGroupAssignmentCreateRequest"}}}},"responses":{"201":{"$ref":"#/components/responses/ItemGroupAssignmentStatusCode201Created"},"404":{"$ref":"#/components/responses/StatusCode404"}}},"get":{"summary":"List Item Group Assignments","description":"Retrieves a list of all item group assignments available in the system.","tags":["Item Group Assignments"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ItemGroupAssignmentQueryFields"},{"$ref":"#/components/parameters/ItemGroupAssignmentQueryListSort"},{"$ref":"#/components/parameters/ItemGroupAssignmentQueryListFilterByItemGroupID"},{"$ref":"#/components/parameters/ItemGroupAssignmentQueryListFilterByItemID"},{"$ref":"#/components/parameters/QueryListFilterByRecordCreatedAt"},{"$ref":"#/components/parameters/QueryListFilterByRecordUpdatedAt"},{"$ref":"#/components/parameters/QueryListPageSize"},{"$ref":"#/components/parameters/QueryListCursor"}],"responses":{"200":{"$ref":"#/components/responses/ItemGroupAssignmentStatusCode200List"},"404":{"$ref":"#/components/responses/StatusCode404"},"422":{"$ref":"#/components/responses/StatusCode422"}}}},"/v1/item-group-item-assignments/{id}":{"delete":{"summary":"Delete Item Group Assignment","description":"Removes an item group assignment from the system.","tags":["Item Group Assignments"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"id","in":"path","description":"Item Group Assignment ID","required":true,"schema":{"type":"string"}}],"responses":{"204":{"$ref":"#/components/responses/StatusCode204Deleted"},"404":{"$ref":"#/components/responses/StatusCode404"}}},"get":{"summary":"Fetch Item Group Assignment","description":"Retrieves detailed information about a specific item group assignment.","tags":["Item Group Assignments"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"id","in":"path","description":"Item Group Assignment ID","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/ItemGroupAssignmentQueryFields"}],"responses":{"200":{"$ref":"#/components/responses/ItemGroupAssignmentStatusCode200"},"404":{"$ref":"#/components/responses/StatusCode404"}}}},"/v1/item-groups":{"post":{"summary":"Create Item Group","description":"Adds a new item group to organize items.","tags":["Item Groups"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ItemGroupQueryFields"}],"requestBody":{"required":true,"description":"Request body to create an Item Group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemGroupCreateRequest"}}}},"responses":{"201":{"$ref":"#/components/responses/ItemGroupStatusCode201Created"},"404":{"$ref":"#/components/responses/StatusCode404"}}},"get":{"summary":"List Item Groups","description":"Retrieves a list of all item groups available in the system.","tags":["Item Groups"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ItemGroupQueryFields"},{"$ref":"#/components/parameters/ItemGroupQueryListSort"},{"$ref":"#/components/parameters/QueryListFilterByName"},{"$ref":"#/components/parameters/QueryListFilterByRecordCreatedAt"},{"$ref":"#/components/parameters/QueryListFilterByRecordUpdatedAt"},{"$ref":"#/components/parameters/QueryListPageSize"},{"$ref":"#/components/parameters/QueryListCursor"}],"responses":{"200":{"$ref":"#/components/responses/ItemGroupStatusCode200List"},"404":{"$ref":"#/components/responses/StatusCode404"},"422":{"$ref":"#/components/responses/StatusCode422"}}}},"/v1/item-groups/{id}":{"delete":{"summary":"Delete Item Group","description":"Removes an item group from the system.","tags":["Item Groups"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"id","in":"path","description":"Item Group ID","required":true,"schema":{"type":"string"}}],"responses":{"204":{"$ref":"#/components/responses/StatusCode204Deleted"},"404":{"$ref":"#/components/responses/StatusCode404"}}},"get":{"summary":"Fetch Item Group","description":"Retrieves detailed information about a specific item group.","tags":["Item Groups"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"id","in":"path","description":"Item Group ID","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/ItemGroupQueryFields"}],"responses":{"200":{"$ref":"#/components/responses/ItemGroupStatusCode200"},"404":{"$ref":"#/components/responses/StatusCode404"}}},"patch":{"summary":"Update Item Group","description":"Modifies the properties or configuration of an existing item group.","tags":["Item Groups"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"id","in":"path","description":"Item Group ID","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/ItemGroupQueryFields"}],"requestBody":{"required":true,"description":"Request body to update an Item Group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemGroupUpdateRequest"}}}},"responses":{"200":{"$ref":"#/components/responses/ItemGroupStatusCode200Updated"},"404":{"$ref":"#/components/responses/StatusCode404"}}}},"/v1/item-option-values":{"post":{"summary":"Create Item Option Value","description":"Adds a new value to an item option.","tags":["Item Option Values"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ItemOptionValueQueryFields"}],"requestBody":{"required":true,"description":"Request body to create an Item Option Value.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemOptionValueCreateRequest"}}}},"responses":{"201":{"$ref":"#/components/responses/ItemOptionValueStatusCode201Created"},"404":{"$ref":"#/components/responses/StatusCode404"}}},"get":{"summary":"List Item Option Values","description":"Retrieves a list of all item option values available in the system.","tags":["Item Option Values"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ItemOptionValueQueryFields"},{"$ref":"#/components/parameters/ItemOptionValueQueryListSort"},{"$ref":"#/components/parameters/ItemOptionValueQueryListFilterByCode"},{"$ref":"#/components/parameters/ItemOptionValueQueryListFilterByItemID"},{"$ref":"#/components/parameters/ItemOptionValueQueryListFilterByItemOptionID"},{"$ref":"#/components/parameters/QueryListFilterByName"},{"$ref":"#/components/parameters/QueryListFilterByRecordCreatedAt"},{"$ref":"#/components/parameters/QueryListFilterByRecordUpdatedAt"},{"$ref":"#/components/parameters/QueryListPageSize"},{"$ref":"#/components/parameters/QueryListCursor"}],"responses":{"200":{"$ref":"#/components/responses/ItemOptionValueStatusCode200List"},"404":{"$ref":"#/components/responses/StatusCode404"},"422":{"$ref":"#/components/responses/StatusCode422"}}}},"/v1/item-option-values/{id}":{"delete":{"summary":"Delete Item Option Value","description":"Removes an item option value from an item option.","tags":["Item Option Values"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"id","in":"path","description":"Item Option Value ID","required":true,"schema":{"type":"string"}}],"responses":{"204":{"$ref":"#/components/responses/StatusCode204Deleted"},"404":{"$ref":"#/components/responses/StatusCode404"}}},"get":{"summary":"Fetch Item Option Value","description":"Retrieves detailed information about a specific item option value.","tags":["Item Option Values"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"id","in":"path","description":"Item Option Value ID","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/ItemOptionValueQueryFields"}],"responses":{"200":{"$ref":"#/components/responses/ItemOptionValueStatusCode200"},"404":{"$ref":"#/components/responses/StatusCode404"}}},"patch":{"summary":"Update Item Option Value","description":"Modifies the properties or configuration of an existing item option value.","tags":["Item Option Values"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"id","in":"path","description":"Item Option Value ID","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/ItemOptionValueQueryFields"}],"requestBody":{"required":true,"description":"Request body to update an Item Option Value.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemOptionValueUpdateRequest"}}}},"responses":{"200":{"$ref":"#/components/responses/ItemOptionValueStatusCode200Updated"},"404":{"$ref":"#/components/responses/StatusCode404"}}}},"/v1/item-options":{"post":{"summary":"Create Item Option","description":"Adds a new item option to an item.","tags":["Item Options"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ItemOptionQueryFields"}],"requestBody":{"required":true,"description":"Request body to create an Item Option.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemOptionCreateRequest"}}}},"responses":{"201":{"$ref":"#/components/responses/ItemOptionStatusCode201Created"},"404":{"$ref":"#/components/responses/StatusCode404"}}},"get":{"summary":"List Item Options","description":"Retrieves a list of all item options available in the system.","tags":["Item Options"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ItemOptionQueryFields"},{"$ref":"#/components/parameters/ItemOptionQueryListSort"},{"$ref":"#/components/parameters/ItemOptionQueryListFilterByItemID"},{"$ref":"#/components/parameters/QueryListFilterByName"},{"$ref":"#/components/parameters/QueryListFilterByRecordCreatedAt"},{"$ref":"#/components/parameters/QueryListFilterByRecordUpdatedAt"},{"$ref":"#/components/parameters/QueryListPageSize"},{"$ref":"#/components/parameters/QueryListCursor"}],"responses":{"200":{"$ref":"#/components/responses/ItemOptionStatusCode200List"},"404":{"$ref":"#/components/responses/StatusCode404"},"422":{"$ref":"#/components/responses/StatusCode422"}}}},"/v1/item-options/{id}":{"delete":{"summary":"Delete Item Option","description":"Removes an item option from an item.","tags":["Item Options"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"id","in":"path","description":"Item Option ID","required":true,"schema":{"type":"string"}}],"responses":{"204":{"$ref":"#/components/responses/StatusCode204Deleted"},"404":{"$ref":"#/components/responses/StatusCode404"}}},"get":{"summary":"Fetch Item Option","description":"Retrieves detailed information about a specific item option.","tags":["Item Options"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"id","in":"path","description":"Item Option ID","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/ItemOptionQueryFields"}],"responses":{"200":{"$ref":"#/components/responses/ItemOptionStatusCode200"},"404":{"$ref":"#/components/responses/StatusCode404"}}},"patch":{"summary":"Update Item Option","description":"Modifies the properties or configuration of an existing item option.","tags":["Item Options"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"id","in":"path","description":"Item Option ID","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/ItemOptionQueryFields"}],"requestBody":{"required":true,"description":"Request body to update an Item Option.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemOptionUpdateRequest"}}}},"responses":{"200":{"$ref":"#/components/responses/ItemOptionStatusCode200Updated"},"404":{"$ref":"#/components/responses/StatusCode404"}}}},"/v1/item-tiers":{"post":{"summary":"Create Item Tier","description":"Adds a new pricing tier to an item.","tags":["Item Tiers"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ItemTierQueryFields"}],"requestBody":{"required":true,"description":"Request body to create an Item Tier.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemTierCreateRequest"}}}},"responses":{"201":{"$ref":"#/components/responses/ItemTierStatusCode201Created"},"404":{"$ref":"#/components/responses/StatusCode404"}}},"get":{"summary":"List Item Tiers","description":"Retrieves a list of all item tiers available in the system.","tags":["Item Tiers"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ItemTierQueryFields"},{"$ref":"#/components/parameters/ItemTierQueryListSort"},{"$ref":"#/components/parameters/ItemTierQueryListFilterByItemID"},{"$ref":"#/components/parameters/QueryListFilterByRecordCreatedAt"},{"$ref":"#/components/parameters/QueryListFilterByRecordUpdatedAt"},{"$ref":"#/components/parameters/QueryListPageSize"},{"$ref":"#/components/parameters/QueryListCursor"}],"responses":{"200":{"$ref":"#/components/responses/ItemTierStatusCode200List"},"404":{"$ref":"#/components/responses/StatusCode404"},"422":{"$ref":"#/components/responses/StatusCode422"}}}},"/v1/item-tiers/{id}":{"delete":{"summary":"Delete Item Tier","description":"Removes an item tier from an item.","tags":["Item Tiers"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"id","in":"path","description":"Item Tier ID","required":true,"schema":{"type":"string"}}],"responses":{"204":{"$ref":"#/components/responses/StatusCode204Deleted"},"404":{"$ref":"#/components/responses/StatusCode404"}}},"get":{"summary":"Fetch Item Tier","description":"Retrieves detailed information about a specific item tier.","tags":["Item Tiers"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"id","in":"path","description":"Item Tier ID","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/ItemTierQueryFields"}],"responses":{"200":{"$ref":"#/components/responses/ItemTierStatusCode200"},"404":{"$ref":"#/components/responses/StatusCode404"}}},"patch":{"summary":"Update Item Tier","description":"Modifies the properties or configuration of an existing item tier.","tags":["Item Tiers"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"id","in":"path","description":"Item Tier ID","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/ItemTierQueryFields"}],"requestBody":{"required":true,"description":"Request body to update an Item Tier.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemTierUpdateRequest"}}}},"responses":{"200":{"$ref":"#/components/responses/ItemTierStatusCode200Updated"},"404":{"$ref":"#/components/responses/StatusCode404"}}}},"/v1/items":{"post":{"summary":"Create Item","description":"Adds a new item to your product catalog.","tags":["Items"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ItemQueryFields"}],"requestBody":{"required":true,"description":"Request body to create an Item.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemCreateRequest"}}}},"responses":{"201":{"$ref":"#/components/responses/ItemStatusCode201Created"},"404":{"$ref":"#/components/responses/StatusCode404"}}},"get":{"summary":"List Items","description":"Retrieves a list of all items available in the system.","tags":["Items"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ItemQueryFields"},{"$ref":"#/components/parameters/ItemQueryListSort"},{"$ref":"#/components/parameters/ItemQueryListFilterByCategoryID"},{"$ref":"#/components/parameters/ItemQueryListFilterByCode"},{"$ref":"#/components/parameters/ItemQueryListFilterByManufacturerID"},{"$ref":"#/components/parameters/QueryListFilterByName"},{"$ref":"#/components/parameters/QueryListFilterByRecordCreatedAt"},{"$ref":"#/components/parameters/QueryListFilterByRecordUpdatedAt"},{"$ref":"#/components/parameters/ItemQueryListFilterBySKU"},{"$ref":"#/components/parameters/ItemQueryListFilterBySupplierID"},{"$ref":"#/components/parameters/QueryListPageSize"},{"$ref":"#/components/parameters/QueryListCursor"}],"responses":{"200":{"$ref":"#/components/responses/ItemStatusCode200List"},"404":{"$ref":"#/components/responses/StatusCode404"},"422":{"$ref":"#/components/responses/StatusCode422"}}}},"/v1/items/{id}":{"delete":{"summary":"Delete Item","description":"Removes an item from your product catalog.","tags":["Items"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"id","in":"path","description":"Item ID","required":true,"schema":{"type":"string"}}],"responses":{"204":{"$ref":"#/components/responses/StatusCode204Deleted"},"404":{"$ref":"#/components/responses/StatusCode404"}}},"get":{"summary":"Fetch Item","description":"Retrieves detailed information about a specific item.","tags":["Items"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"id","in":"path","description":"Item ID","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/ItemQueryFields"}],"responses":{"200":{"$ref":"#/components/responses/ItemStatusCode200"},"404":{"$ref":"#/components/responses/StatusCode404"}}},"patch":{"summary":"Update Item","description":"Modifies the properties or configuration of an existing item.","tags":["Items"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"id","in":"path","description":"Item ID","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/ItemQueryFields"}],"requestBody":{"required":true,"description":"Request body to update an Item.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemUpdateRequest"}}}},"responses":{"200":{"$ref":"#/components/responses/ItemStatusCode200Updated"},"404":{"$ref":"#/components/responses/StatusCode404"}}}},"/v1/manufacturers":{"post":{"summary":"Create Manufacturer","description":"Adds a new manufacturer to the system.","tags":["Manufacturers"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ManufacturerQueryFields"}],"requestBody":{"required":true,"description":"Request body to create a Manufacturer.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManufacturerCreateRequest"}}}},"responses":{"201":{"$ref":"#/components/responses/ManufacturerStatusCode201Created"},"404":{"$ref":"#/components/responses/StatusCode404"}}},"get":{"summary":"List Manufacturers","description":"Retrieves a list of all manufacturers available in the system.","tags":["Manufacturers"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/ManufacturerQueryFields"},{"$ref":"#/components/parameters/ManufacturerQueryListSort"},{"$ref":"#/components/parameters/QueryListFilterByName"},{"$ref":"#/components/parameters/QueryListFilterByRecordCreatedAt"},{"$ref":"#/components/parameters/QueryListFilterByRecordUpdatedAt"},{"$ref":"#/components/parameters/QueryListPageSize"},{"$ref":"#/components/parameters/QueryListCursor"}],"responses":{"200":{"$ref":"#/components/responses/ManufacturerStatusCode200List"},"404":{"$ref":"#/components/responses/StatusCode404"},"422":{"$ref":"#/components/responses/StatusCode422"}}}},"/v1/manufacturers/{id}":{"delete":{"summary":"Delete Manufacturer","description":"Removes a manufacturer from the system.","tags":["Manufacturers"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"id","in":"path","description":"Manufacturer ID","required":true,"schema":{"type":"string"}}],"responses":{"204":{"$ref":"#/components/responses/StatusCode204Deleted"},"404":{"$ref":"#/components/responses/StatusCode404"}}},"get":{"summary":"Fetch Manufacturer","description":"Retrieves detailed information about a specific manufacturer.","tags":["Manufacturers"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"id","in":"path","description":"Manufacturer ID","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/ManufacturerQueryFields"}],"responses":{"200":{"$ref":"#/components/responses/ManufacturerStatusCode200"},"404":{"$ref":"#/components/responses/StatusCode404"}}},"patch":{"summary":"Update Manufacturer","description":"Modifies the properties or configuration of an existing manufacturer.","tags":["Manufacturers"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"id","in":"path","description":"Manufacturer ID","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/ManufacturerQueryFields"}],"requestBody":{"required":true,"description":"Request body to update a Manufacturer.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManufacturerUpdateRequest"}}}},"responses":{"200":{"$ref":"#/components/responses/ManufacturerStatusCode200Updated"},"404":{"$ref":"#/components/responses/StatusCode404"}}}},"/v1/suppliers":{"post":{"summary":"Create Supplier","description":"Adds a new supplier to the system.","tags":["Suppliers"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/SupplierQueryFields"}],"requestBody":{"required":true,"description":"Request body to create a Supplier.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierCreateRequest"}}}},"responses":{"201":{"$ref":"#/components/responses/SupplierStatusCode201Created"},"404":{"$ref":"#/components/responses/StatusCode404"}}},"get":{"summary":"List Suppliers","description":"Retrieves a list of all suppliers available in the system.","tags":["Suppliers"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/SupplierQueryFields"},{"$ref":"#/components/parameters/SupplierQueryListSort"},{"$ref":"#/components/parameters/QueryListFilterByName"},{"$ref":"#/components/parameters/QueryListFilterByRecordCreatedAt"},{"$ref":"#/components/parameters/QueryListFilterByRecordUpdatedAt"},{"$ref":"#/components/parameters/QueryListPageSize"},{"$ref":"#/components/parameters/QueryListCursor"}],"responses":{"200":{"$ref":"#/components/responses/SupplierStatusCode200List"},"404":{"$ref":"#/components/responses/StatusCode404"},"422":{"$ref":"#/components/responses/StatusCode422"}}}},"/v1/suppliers/{id}":{"delete":{"summary":"Delete Supplier","description":"Removes a supplier from the system.","tags":["Suppliers"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"id","in":"path","description":"Supplier ID","required":true,"schema":{"type":"string"}}],"responses":{"204":{"$ref":"#/components/responses/StatusCode204Deleted"},"404":{"$ref":"#/components/responses/StatusCode404"}}},"get":{"summary":"Fetch Supplier","description":"Retrieves detailed information about a specific supplier.","tags":["Suppliers"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"id","in":"path","description":"Supplier ID","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/SupplierQueryFields"}],"responses":{"200":{"$ref":"#/components/responses/SupplierStatusCode200"},"404":{"$ref":"#/components/responses/StatusCode404"}}},"patch":{"summary":"Update Supplier","description":"Modifies the properties or configuration of an existing supplier.","tags":["Suppliers"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"id","in":"path","description":"Supplier ID","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/SupplierQueryFields"}],"requestBody":{"required":true,"description":"Request body to update a Supplier.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierUpdateRequest"}}}},"responses":{"200":{"$ref":"#/components/responses/SupplierStatusCode200Updated"},"404":{"$ref":"#/components/responses/StatusCode404"}}}},"/v1/datafeeds/supplier-items":{"get":{"summary":"List Supplier Items","description":"Retrieves supplier item data for specified MPNs from suppliers configured through SupplierSync. Format includes modern cursor-based pagination, advanced filtering with operators, and normalized timestamp fields. Results exclude native distributor integrations and are limited to SupplierSync sources. Note that other supplier-related endpoints (e.g., ListSuppliers, CreateSupplier) interact with a separate supplier object and do not affect supplier items.\n","tags":["Data Feed Suppliers"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/DatafeedsSupplierItemQueryFilterMPN"},{"$ref":"#/components/parameters/QueryPageSize"},{"$ref":"#/components/parameters/QueryCursor"}],"responses":{"200":{"$ref":"#/components/responses/DatafeedsSupplierItemListStatusCode200"},"400":{"$ref":"#/components/responses/StatusCode400"},"422":{"$ref":"#/components/responses/StatusCode422"}}}},"/v1/datafeeds/suppliers":{"get":{"summary":"List Suppliers","description":"Retrieves a list of suppliers configured through SupplierSync. Format includes modern cursor-based pagination and normalized timestamp fields.\n","tags":["Data Feed Suppliers"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"$ref":"#/components/parameters/DatafeedsSupplierQueryListSort"},{"$ref":"#/components/parameters/QueryPageSize"},{"$ref":"#/components/parameters/QueryCursor"}],"responses":{"200":{"$ref":"#/components/responses/DatafeedsSupplierListStatusCode200"},"400":{"$ref":"#/components/responses/StatusCode400"},"422":{"$ref":"#/components/responses/StatusCode422"}}}}},"components":{"schemas":{"LineItemCreateRequest":{"type":"object","description":"Request payload for creating a new line item.","properties":{"category":{"description":"Category classification for the line item.","example":"Hardware","type":"string"},"description":{"description":"Detailed description of the line item.","example":"High-performance server with advanced specifications","nullable":true,"type":"string"},"manufacturer":{"description":"Manufacturer of the product/service.","example":"Dell Technologies","nullable":true,"type":"string"},"name":{"description":"Display name of the line item.","example":"PowerEdge R750 Server","type":"string"},"part_number":{"description":"Manufacturer part number for the product.","example":"R750-001","nullable":true,"type":"string"},"quantity":{"description":"Quantity of the item being quoted.","example":2.5,"type":"number"},"quote_id":{"description":"ID of the quote this line item belongs to.","example":"quot_38XGTCYo6Bvr16nr8mIa7XSLytV","type":"string"},"recurring":{"description":"Indicates if this is a recurring/subscription item.","example":true,"nullable":true,"type":"boolean"},"supplier":{"description":"Supplier/vendor of the product.","example":"Tech Distribution Corp","nullable":true,"type":"string"},"supplier_sku":{"description":"Supplier's internal SKU for the product.","example":"TDC-R750-001","nullable":true,"type":"string"},"taxable":{"description":"Indicates if the item is subject to tax.","example":true,"nullable":true,"type":"boolean"},"unit_cost":{"description":"Cost per unit for margin calculation.","example":1250.5,"nullable":true,"type":"number"},"unit_price":{"description":"Price per unit charged to customer.","example":1875.75,"nullable":true,"type":"number"}},"required":["category","name","quantity","quote_id"]},"LineItem":{"type":"object","description":"Represents a line item within a quote with product and pricing details.","properties":{"category":{"description":"Category classification for the line item.","example":"Hardware","type":"string"},"description":{"description":"Detailed description of the line item.","example":"High-performance server with advanced specifications","type":"string"},"id":{"description":"Unique identifier for the line item.","example":"litm_38XGTCYo6Bvr16nr8mIa7XSLytV","type":"string"},"manufacturer":{"description":"Manufacturer of the product/service.","example":"Dell Technologies","type":"string"},"name":{"description":"Display name of the line item.","example":"PowerEdge R750 Server","type":"string"},"part_number":{"description":"Manufacturer part number for the product.","example":"R750-001","type":"string"},"quantity":{"description":"Quantity of the item being quoted.","example":2.5,"type":"number"},"quote_id":{"description":"Unique identifier of the quote this line item belongs to.","example":"quot_38XGTCYo6Bvr16nr8mIa7XSLytV","type":"string"},"record_created_at":{"description":"Timestamp when the line item was created.","example":"2024-01-15T10:30:00Z","format":"date-time","type":"string"},"record_updated_at":{"description":"Timestamp when the line item was last updated.","example":"2024-01-15T15:45:00Z","format":"date-time","type":"string"},"recurring":{"description":"Indicates if this is a recurring/subscription item.","example":true,"type":"boolean"},"supplier":{"description":"Supplier/vendor of the product.","example":"Tech Distribution Corp","type":"string"},"supplier_sku":{"description":"Supplier's internal SKU for the product.","example":"TDC-R750-001","type":"string"},"taxable":{"description":"Indicates if the item is subject to tax.","example":true,"type":"boolean"},"unit_cost":{"description":"Cost per unit for margin calculation.","example":"1250.50","type":"string"},"unit_price":{"description":"Price per unit charged to customer.","example":1875.75,"type":"number"}},"required":["category","description","id","manufacturer","name","part_number","quantity","quote_id","record_created_at","record_updated_at","recurring","supplier","supplier_sku","taxable","unit_cost","unit_price"]},"QuoteTemplateList":{"type":"object","description":"A list of quote templates stored in the system.","properties":{"data":{"description":"Array of quote template objects.","items":{"$ref":"#/components/schemas/QuoteTemplate"},"type":"array"},"next_cursor":{"description":"Cursor for pagination to fetch the next page of results.","example":"WyIzIl0=","nullable":true,"type":"string"},"total_count":{"description":"Total number of quote templates.","example":15,"type":"integer"}}},"QuoteTemplate":{"type":"object","description":"Represents a quote template used to create standardized quotes.","properties":{"id":{"description":"Unique identifier for the quote template.","example":"quot_38MAkwFXptvtDNBHj8B6fgCfZka","type":"string"},"record_created_at":{"description":"Timestamp when the quote template was created.","example":"2024-01-15T10:30:00Z","format":"date-time","type":"string"},"record_updated_at":{"description":"Timestamp when the quote template was last updated.","example":"2024-01-15T15:45:00Z","format":"date-time","type":"string"},"slug":{"description":"URL-friendly identifier for the quote template.","example":"business-proposal-template","type":"string"},"title":{"description":"Display name of the quote template.","example":"Business Proposal Template","type":"string"}},"required":["id","record_created_at","record_updated_at","slug","title"]},"QuoteList":{"type":"object","description":"A list of quotes stored in the system.","properties":{"data":{"description":"Array of quote objects.","items":{"$ref":"#/components/schemas/Quote"},"type":"array"},"next_cursor":{"description":"Cursor for pagination to fetch the next page of results.","example":"WyIzIl0=","nullable":true,"type":"string"},"total_count":{"description":"Total number of quotes.","example":252,"type":"integer"}}},"Quote":{"type":"object","description":"Represents a full sales quote with pricing details.","properties":{"annual_cost_decimal":{"description":"Total annual cost before discounts, tax, and margin.","example":null,"nullable":true,"type":"string"},"annual_discount_decimal":{"description":"Annual discount amount applied to the quote.","example":null,"nullable":true,"type":"string"},"annual_discounted_subtotal_decimal":{"description":"Annual subtotal after discounts but before tax.","example":null,"nullable":true,"type":"string"},"annual_margin_decimal":{"description":"Gross profit margin for the annual portion of the quote.","example":null,"nullable":true,"type":"string"},"annual_subtotal_decimal":{"description":"Annual subtotal before discount and tax.","example":null,"nullable":true,"type":"string"},"annual_tax_total_decimal":{"description":"Total tax applied to annual items.","example":null,"nullable":true,"type":"string"},"annual_total_decimal":{"description":"Final total for annual items including tax and discounts.","example":null,"nullable":true,"type":"string"},"annual_upfront_payments":{"description":"Upfront payments required for annual items.","example":null,"nullable":true,"type":"string"},"autotask_opportunity_id":{"description":"External Autotask intergration opportunity ID","example":"abc123def456","nullable":true,"type":"string"},"billing_address":{"description":"Billing address information.","nullable":true,"type":"object","properties":{"address_line_1":{"description":"First line of the billing address.","example":"225 Cedar Street","nullable":true,"type":"string"},"address_line_2":{"description":"Second line of the billing address.","example":null,"nullable":true,"type":"string"},"address_line_3":{"example":null,"nullable":true,"type":"string"},"city":{"description":"City of the billing address.","example":"Seattle","nullable":true,"type":"string"},"country_code":{"description":"ISO country code of the billing address.","example":"US","nullable":true,"type":"string"},"country_name":{"example":null,"nullable":true,"type":"string"},"geo_spatial_coordinates":{"example":null,"nullable":true,"type":"string"},"is_eu":{"example":null,"nullable":true,"type":"boolean"},"postal_code":{"description":"Postal code of the billing address.","example":"98121","nullable":true,"type":"string"},"state_prov_code":{"description":"State/province code of the billing address.","example":"WA","nullable":true,"type":"string"},"state_prov_name":{"example":null,"nullable":true,"type":"string"}}},"billing_first_name":{"description":"First name of the billing contact.","example":"John","nullable":true,"type":"string"},"billing_last_name":{"description":"Last name of the billing contact.","example":"Doe","nullable":true,"type":"string"},"billing_organization":{"description":"Organization associated with the billing contact.","example":"Microsoft","nullable":true,"type":"string"},"client":{"description":"Client associated with the quote's billing contact.","type":"object","properties":{"id":{"description":"ID of the Scalepad Client associated with the billing contact.","example":"03840c4b-5999-49ac-80b6-0e6000a758fd","nullable":true,"type":"string"},"name":{"description":"Name of the Scalepad Client associated with the billing contact.","example":"Acme Inc","nullable":true,"type":"string"}}},"connectwise_opportunity_id":{"description":"External ConnectWise intergration opportunity ID for integration","example":"ghi789jkl012","nullable":true,"type":"string"},"record_created_at":{"description":"Timestamp when the quote was created.","format":"date-time","type":"string"},"currency_iso":{"description":"ISO code for the currency used in the quote.","example":"CAD","type":"string"},"custom_number":{"description":"Custom quote number provided by the user.","example":"Quote Custom Number","nullable":true,"type":"string"},"draft":{"description":"Indicates whether the quote is still in draft stage.","example":false,"type":"boolean"},"email_first_sent_at":{"description":"Timestamp when the quote was first sent via email.","format":"date-time","nullable":true,"type":"string"},"email_last_sent_at":{"description":"Timestamp when the quote was most recently emailed.","format":"date-time","nullable":true,"type":"string"},"email_status":{"description":"Current email status of the quote (e.g., sent, failed).","example":"sent","type":"string"},"expired_at":{"description":"Timestamp indicating when the quote expires.","format":"date-time","type":"string"},"flagged":{"description":"Indicates if the quote is flagged for follow-up or review.","example":false,"type":"boolean"},"halo_opportunity_id":{"description":"External Halo intergration opportunity ID for integration","example":"mno345pqr678","nullable":true,"type":"string"},"hubspot_deal_id":{"description":"External HubSpot intergration deal ID for integration","example":"stu901vwx234","nullable":true,"type":"string"},"id":{"description":"Unique identifier for the quote.","example":"quot_2TSEPTEfnooIhvA83l78R0nEqR5","type":"string"},"internal_notes":{"description":"Internal notes related to the quote.","example":"some internal notes","nullable":true,"type":"string"},"kaseya_opportunity_id":{"description":"External Kaseya intergration opportunity ID for integration","example":"yza567bcd890","nullable":true,"type":"string"},"record_updated_at":{"description":"Timestamp of the most recent update.","format":"date-time","type":"string"},"lm_initiative_id":{"description":"Lifecycle Manager Initiative ID","example":"b4360aa4-1ff1-4ac6-ba99-ed5055262006","nullable":true,"type":"string"},"monthly_cost_decimal":{"description":"Monthly cost before discounts and tax.","example":"30.10","nullable":true,"type":"string"},"monthly_discount_decimal":{"description":"Monthly discount applied.","example":"4.00","nullable":true,"type":"string"},"monthly_discounted_subtotal_decimal":{"description":"Monthly subtotal after discounts.","example":"50.10","nullable":true,"type":"string"},"monthly_margin_decimal":{"description":"Margin for the monthly portion.","example":"15.00","nullable":true,"type":"string"},"monthly_subtotal_decimal":{"description":"Monthly subtotal before discounts and tax.","example":"60.00","nullable":true,"type":"string"},"monthly_tax_total_decimal":{"description":"Tax total for monthly items.","example":"9.68","nullable":true,"type":"string"},"monthly_total_decimal":{"description":"Total for monthly items including discounts and tax.","example":"61.00","nullable":true,"type":"string"},"monthly_upfront_payments":{"description":"Upfront payments for monthly items.","example":"1","nullable":true,"type":"string"},"name":{"description":"Display name of the quote.","example":"Sample Quote","type":"string"},"number":{"description":"System-generated or user-defined quote number.","example":"13","type":"string"},"one_time_cost_decimal":{"description":"Cost for one-time items before discounts and tax.","example":"2.00","nullable":true,"type":"string"},"one_time_discount_decimal":{"description":"Discount amount for one-time items.","example":"6.00","nullable":true,"type":"string"},"one_time_discounted_subtotal_decimal":{"description":"Subtotal for one-time items after discounts.","example":"8.00","nullable":true,"type":"string"},"one_time_margin_decimal":{"description":"Margin on one-time items.","example":"2.00","nullable":true,"type":"string"},"one_time_subtotal_decimal":{"description":"Subtotal for one-time items before tax and discount.","example":"6.00","nullable":true,"type":"string"},"one_time_tax_total_decimal":{"description":"Total tax for one-time items.","example":"1.75","nullable":true,"type":"string"},"one_time_total_decimal":{"description":"Final total for one-time items.","example":"10.75","nullable":true,"type":"string"},"owner_first_name":{"description":"First name of the quote owner.","example":"Walter","nullable":true,"type":"string"},"owner_id":{"description":"ID of the quote owner.","example":"2TSEPTEfnooIhvA83l78R0nEqR5","type":"string"},"owner_last_name":{"description":"Last name of the quote owner.","example":"Melon","nullable":true,"type":"string"},"pipedrive_deal_id":{"description":"External PipeDrive intergration deal ID for integration","example":"efg123hij456","nullable":true,"type":"string"},"primary":{"description":"Indicates that this is the primary quote and not a prior version of the quote.","example":false,"type":"boolean"},"quarterly_cost_decimal":{"description":"Quarterly cost before discounts and tax.","example":null,"nullable":true,"type":"string"},"quarterly_discount_decimal":{"description":"Discount applied to quarterly items.","example":null,"nullable":true,"type":"string"},"quarterly_discounted_subtotal_decimal":{"description":"Subtotal after discount for quarterly items.","example":null,"nullable":true,"type":"string"},"quarterly_margin_decimal":{"description":"Margin on quarterly items.","example":null,"nullable":true,"type":"string"},"quarterly_subtotal_decimal":{"description":"Subtotal before tax and discount for quarterly items.","example":null,"nullable":true,"type":"string"},"quarterly_tax_total_decimal":{"description":"Tax applied to quarterly items.","example":null,"nullable":true,"type":"string"},"quarterly_total_decimal":{"description":"Total amount for quarterly items.","example":null,"nullable":true,"type":"string"},"quarterly_upfront_payments":{"description":"Upfront payments for quarterly items.","example":null,"nullable":true,"type":"string"},"quickbooks_invoice_id":{"description":"External QuickBooks intergration invoice ID for integration","example":"klm789nop012","nullable":true,"type":"string"},"revision":{"description":"Revision identifier for the quote.","example":"3","type":"string"},"salesforce_opportunity_id":{"description":"External Salesforce intergration opportunity ID for integration","example":"qrs345tuv678","nullable":true,"type":"string"},"semi_annual_cost_decimal":{"description":"Semi-annual cost before discounts and tax.","example":null,"nullable":true,"type":"string"},"semi_annual_discount_decimal":{"description":"Discount for semi-annual items.","example":null,"nullable":true,"type":"string"},"semi_annual_discounted_subtotal_decimal":{"description":"Subtotal after discounts for semi-annual items.","example":null,"nullable":true,"type":"string"},"semi_annual_margin_decimal":{"description":"Margin on semi-annual items.","example":null,"nullable":true,"type":"string"},"semi_annual_subtotal_decimal":{"description":"Subtotal before discount and tax.","example":null,"nullable":true,"type":"string"},"semi_annual_tax_total_decimal":{"description":"Total tax for semi-annual items.","example":null,"nullable":true,"type":"string"},"semi_annual_total_decimal":{"description":"Final amount for semi-annual items.","example":null,"nullable":true,"type":"string"},"semi_annual_upfront_payments":{"description":"Upfront payments for semi-annual items.","example":null,"nullable":true,"type":"string"},"shipping_address":{"description":"Shipping address information.","nullable":true,"type":"object","properties":{"address_line_1":{"description":"First line of the shipping address.","example":"2130 Thurston Dr","nullable":true,"type":"string"},"address_line_2":{"description":"Second line of the shipping address.","example":null,"nullable":true,"type":"string"},"address_line_3":{"example":null,"nullable":true,"type":"string"},"city":{"description":"City of the shipping address.","example":"Orleans","nullable":true,"type":"string"},"country_code":{"description":"ISO country code of the shipping address.","example":"CA","nullable":true,"type":"string"},"country_name":{"example":null,"nullable":true,"type":"string"},"geo_spatial_coordinates":{"example":null,"nullable":true,"type":"string"},"is_eu":{"example":null,"nullable":true,"type":"boolean"},"postal_code":{"description":"Postal code of the shipping address.","example":"K1C 1S6","nullable":true,"type":"string"},"state_prov_code":{"description":"State/province code of the shipping address.","example":"ON","nullable":true,"type":"string"},"state_prov_name":{"example":null,"nullable":true,"type":"string"}}},"shipping_decimal":{"description":"Cost of shipping as a decimal value.","example":"1.00","nullable":true,"type":"string"},"shipping_first_name":{"description":"First name of the shipping contact.","example":"Jane","nullable":true,"type":"string"},"shipping_last_name":{"description":"Last name of the shipping contact.","example":"Doe","nullable":true,"type":"string"},"shipping_organization":{"description":"Organization for the shipping address.","example":"FedEx","nullable":true,"type":"string"},"stage":{"description":"Current stage of the quote.","example":"published","type":"string"},"tags":{"description":"Array of tags associated with the quote.","example":[],"type":"array","items":{"type":"string"}},"upfront_cost_decimal":{"description":"Upfront cost before discount and tax.","example":"50.00","nullable":true,"type":"string"},"upfront_discount_decimal":{"description":"Discount applied to upfront items.","example":"6.00","nullable":true,"type":"string"},"upfront_discounted_subtotal_decimal":{"description":"Subtotal after discount for upfront items.","example":"154.00","nullable":true,"type":"string"},"upfront_margin_decimal":{"description":"Margin on upfront items.","example":"30.00","type":"string"},"upfront_subtotal_decimal":{"description":"Subtotal before tax and discount.","example":"160.00","nullable":true,"type":"string"},"upfront_tax_total_decimal":{"description":"Tax total for upfront items.","example":"15.75","nullable":true,"type":"string"},"upfront_total_decimal":{"description":"Final total for upfront items.","example":"173.00","type":"string"},"uuid":{"description":"Universally unique identifier for the quote.","example":"1436-e2a121e6-d4b3-4d6b-9ad3-e8b877f8580f","type":"string"},"won_at":{"description":"Timestamp when the quote was marked as won.","format":"date-time","type":"string"},"xero_invoice_id":{"description":"External Xero intergration invoice ID for integration","example":"wxy901zab234","nullable":true,"type":"string"},"zoho_deal_id":{"description":"External Zoho intergration deal ID for integration","example":"cde567fgh890","nullable":true,"type":"string"}}},"ErrorResponse":{"description":"Standard error response format.","type":"object","properties":{"errors":{"type":"array","description":"Array of error objects containing details about each issue.","items":{"type":"object","properties":{"detail":{"description":"Human-readable message describing the error.","example":"Invalid filter operator","type":"string"},"code":{"description":"Error code identifying the specific error type.","example":"ERR_INVALID_FILTER_OPERATOR","type":"string"},"title":{"description":"A short, human-readable summary of the error.","example":"Unprocessable Entity","type":"string"}}}}},"required":["message"]},"ErrorResponse404":{"description":"Standard format for reporting API errors.","type":"object","properties":{"errors":{"type":"array","description":"Array of error objects containing details about each issue.","items":{"type":"object","properties":{"detail":{"description":"Human-readable message describing the error.","example":"Record not found","type":"string"},"code":{"description":"Error code identifying the specific error type.","example":"ERR_NOT_FOUND","type":"string"},"title":{"description":"A short, human-readable summary of the error.","example":"Not Found","type":"string"}}}}}},"CategoryCreateRequest":{"type":"object","description":"Used to create a new category in the system.","properties":{"name":{"type":"string","example":"Electronics","description":"The name of the category."},"parent_category":{"type":"string","example":"Technology","description":"The name of the parent category, if any."},"parent_category_id":{"type":"string","example":"cat_OcThl8SOeE8w6JYUznfrnQGdp94","description":"The unique identifier of the parent category, if any."}},"required":["name"]},"CategoryList":{"type":"object","description":"A list of categories available in the system.","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Category"},"description":"Array of category objects."},"next_cursor":{"type":"string","nullable":true,"example":"WyIzIl0=","description":"Base64-encoded cursor for the next page of results. Null if no more results."},"total_count":{"type":"integer","example":1,"description":"Total number of categories returned by the query."}}},"CategoryUpdateRequest":{"type":"object","description":"Used to update the details of an existing category.","properties":{"name":{"type":"string","example":"Electronics","description":"The name of the category."},"parent_category":{"type":"string","example":"Technology","description":"The name of the parent category, if any."},"parent_category_id":{"type":"string","example":"cat_OcThl8SOeE8w6JYUznfrnQGdp94","description":"The unique identifier of the parent category, if any."}}},"Category":{"type":"object","description":"Represents a category for organizing items.","properties":{"id":{"type":"string","example":"cat_OcThl8SOeE8w6JYUznfrnQGdp94","description":"Unique identifier for the category."},"name":{"type":"string","example":"Electronics","description":"The name of the category."},"parent_category":{"type":"string","nullable":true,"example":"Technology","description":"The name of the parent category, if any."},"parent_category_id":{"type":"string","nullable":true,"example":"cat_OcThl8SOeE8w6JYUznfrnQGdp94","description":"The unique identifier of the parent category, if any."},"record_created_at":{"type":"string","format":"date-time","example":"2024-01-15T10:30:00Z","description":"ISO 8601 timestamp when the record was created."},"record_updated_at":{"type":"string","format":"date-time","example":"2024-01-15T15:45:00Z","description":"ISO 8601 timestamp when the record was last updated."}}},"ItemGroupAssignmentCreateRequest":{"type":"object","description":"Used to create a new item group assignment in the system.","properties":{"item_group_id":{"type":"string","example":"igrp_OcThl8SOeE8w6JYUznfrnQGdp94","description":"Unique identifier for the item group."},"item_id":{"type":"string","example":"item_OcThl0eqYyTVQzll6qFrMDMBYyu","description":"Unique identifier for the item."}},"required":["item_group_id","item_id"]},"ItemGroupAssignmentList":{"type":"object","description":"A list of item group assignments available in the system.","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ItemGroupAssignment"},"description":"Array of item group assignment objects."},"next_cursor":{"type":"string","nullable":true,"example":"WyIzIl0=","description":"Base64-encoded cursor for the next page of results. Null if no more results."},"total_count":{"type":"integer","example":1,"description":"Total number of item group assignments returned by the query."}}},"ItemGroupAssignment":{"type":"object","description":"Represents an assignment of an item to an item group.","properties":{"id":{"type":"string","example":"igia_OcThl8SOeE8w6JYUznfrnQGdp94","description":"Unique identifier for the item group assignment."},"item_group_id":{"type":"string","example":"igrp_OcThl8SOeE8w6JYUznfrnQGdp94","description":"Unique identifier for the item group."},"item_id":{"type":"string","example":"item_OcThl0eqYyTVQzll6qFrMDMBYyu","description":"Unique identifier for the item."},"record_created_at":{"type":"string","format":"date-time","example":"2024-01-15T10:30:00Z","description":"ISO 8601 timestamp when the record was created."},"record_updated_at":{"type":"string","format":"date-time","example":"2024-01-15T15:45:00Z","description":"ISO 8601 timestamp when the record was last updated."}}},"ItemGroupCreateRequest":{"type":"object","description":"Used to create a new item group in the system.","properties":{"name":{"type":"string","example":"Electronics","description":"The name of the item group."}},"required":["name"]},"ItemGroupList":{"type":"object","description":"A list of item groups available in the system.","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ItemGroup"},"description":"Array of item group objects."},"next_cursor":{"type":"string","nullable":true,"example":"WyIzIl0=","description":"Base64-encoded cursor for the next page of results. Null if no more results."},"total_count":{"type":"integer","example":1,"description":"Total number of item groups returned by the query."}}},"ItemGroupUpdateRequest":{"type":"object","description":"Used to update the details of an existing item group.","properties":{"name":{"type":"string","example":"Electronics","description":"The name of the item group."}}},"ItemGroup":{"type":"object","description":"Represents a group for organizing items.","properties":{"id":{"type":"string","example":"igrp_OcThl8SOeE8w6JYUznfrnQGdp94","description":"Unique identifier for the item group."},"name":{"type":"string","example":"Electronics","description":"The name of the item group."},"record_created_at":{"type":"string","format":"date-time","example":"2024-01-15T10:30:00Z","description":"ISO 8601 timestamp when the record was created."},"record_updated_at":{"type":"string","format":"date-time","example":"2024-01-15T15:45:00Z","description":"ISO 8601 timestamp when the record was last updated."}}},"ItemOptionValueCreateRequest":{"type":"object","description":"Used to create a new item option value in the system.","properties":{"code":{"type":"string","example":"COLOR_RED","description":"Optional code identifier for the option value."},"cost_decimal":{"type":"string","example":"15.99","description":"Cost associated with this option value in decimal format."},"cost_type":{"type":"string","example":"amount","description":"Type of cost calculation for this option value."},"item_option_id":{"type":"string","example":"iopt_OcThl8SOeE8w6JYUznfrnQGdp94","description":"Unique identifier for the item option this value belongs to."},"name":{"type":"string","example":"Red","description":"The display name of the option value."},"price_decimal":{"type":"string","example":"19.99","description":"Price associated with this option value in decimal format."},"pricing_scheme":{"type":"string","example":"amount","description":"Pricing scheme used for this option value."},"sort_order":{"type":"integer","example":1,"description":"Display order for this option value relative to other values."}},"required":["item_option_id","name"]},"ItemOptionValueList":{"type":"object","description":"A list of item option values available in the system.","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ItemOptionValue"},"description":"Array of item option value objects."},"next_cursor":{"type":"string","nullable":true,"example":"WyIzIl0=","description":"Base64-encoded cursor for the next page of results. Null if no more results."},"total_count":{"type":"integer","example":1,"description":"Total number of item option values returned by the query."}}},"ItemOptionValueUpdateRequest":{"type":"object","description":"Used to update the details of an existing item option value.","properties":{"code":{"type":"string","example":"COLOR_RED","description":"Optional code identifier for the option value."},"cost_decimal":{"type":"string","example":"15.99","description":"Cost associated with this option value in decimal format."},"cost_type":{"type":"string","example":"amount","description":"Type of cost calculation for this option value."},"name":{"type":"string","example":"Red","description":"The display name of the option value."},"price_decimal":{"type":"string","example":"19.99","description":"Price associated with this option value in decimal format."},"pricing_scheme":{"type":"string","example":"amount","description":"Pricing scheme used for this option value."},"sort_order":{"type":"integer","example":1,"description":"Display order for this option value relative to other values."}}},"ItemOptionValue":{"type":"object","description":"Represents a specific value for an item option.","properties":{"code":{"type":"string","example":"COLOR_RED","description":"Optional code identifier for the option value."},"cost_decimal":{"type":"string","example":"15.99","description":"Cost associated with this option value in decimal format."},"cost_type":{"type":"string","example":"amount","description":"Type of cost calculation for this option value."},"id":{"type":"string","example":"iopv_OcThl8SOeE8w6JYUznfrnQGdp94","description":"Unique identifier for the item option value."},"item_id":{"type":"string","example":"item_OcThl0eqYyTVQzll6qFrMDMBYyu","description":"Unique identifier for the item this option value belongs to."},"item_option_id":{"type":"string","example":"iopt_OcThl8SOeE8w6JYUznfrnQGdp94","description":"Unique identifier for the item option this value belongs to."},"name":{"type":"string","example":"Red","description":"The display name of the option value."},"price_decimal":{"type":"string","example":"19.99","description":"Price associated with this option value in decimal format."},"pricing_scheme":{"type":"string","example":"amount","description":"Pricing scheme used for this option value."},"record_created_at":{"type":"string","format":"date-time","example":"2024-01-15T10:30:00Z","description":"ISO 8601 timestamp when the record was created."},"record_updated_at":{"type":"string","format":"date-time","example":"2024-01-15T15:45:00Z","description":"ISO 8601 timestamp when the record was last updated."},"sort_order":{"type":"integer","example":1,"description":"Display order for this option value relative to other values."}}},"ItemOptionCreateRequest":{"type":"object","description":"Used to create a new item option in the system.","properties":{"allow_multiple_values":{"type":"boolean","example":true,"description":"Whether multiple values can be selected for this option."},"description":{"type":"string","example":"Choose your preferred color","description":"Description of the item option."},"extended_description":{"type":"string","example":"Select from our available color options. Additional colors may be available upon request.","description":"Extended description providing additional details about the option."},"item_id":{"type":"string","example":"item_OcThl0eqYyTVQzll6qFrMDMBYyu","description":"Unique identifier for the item this option belongs to."},"name":{"type":"string","example":"Color","description":"The name of the item option."},"required":{"type":"boolean","example":true,"description":"Whether this option is required to be selected."},"sort_order":{"type":"integer","example":1,"description":"Display order for this option relative to other options."}},"required":["item_id","name"]},"ItemOptionList":{"type":"object","description":"A list of item options available in the system.","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ItemOption"},"description":"Array of item option objects."},"next_cursor":{"type":"string","nullable":true,"example":"WyIzIl0=","description":"Base64-encoded cursor for the next page of results. Null if no more results."},"total_count":{"type":"integer","example":1,"description":"Total number of item options returned by the query."}}},"ItemOptionUpdateRequest":{"type":"object","description":"Used to update the details of an existing item option.","properties":{"allow_multiple_values":{"type":"boolean","example":true,"description":"Whether multiple values can be selected for this option."},"description":{"type":"string","example":"Choose your preferred color","description":"Description of the item option."},"extended_description":{"type":"string","example":"Select from our available color options. Additional colors may be available upon request.","description":"Extended description providing additional details about the option."},"name":{"type":"string","example":"Color","description":"The name of the item option."},"required":{"type":"boolean","example":true,"description":"Whether this option is required to be selected."},"sort_order":{"type":"integer","example":1,"description":"Display order for this option relative to other options."}}},"ItemOption":{"type":"object","description":"Represents a configurable option for an item.","properties":{"allow_multiple_values":{"type":"boolean","example":true,"description":"Whether multiple values can be selected for this option."},"description":{"type":"string","example":"Choose your preferred color","description":"Description of the item option."},"extended_description":{"type":"string","example":"Select from our available color options. Additional colors may be available upon request.","description":"Extended description providing additional details about the option."},"id":{"type":"string","example":"iopt_OcThl8SOeE8w6JYUznfrnQGdp94","description":"Unique identifier for the item option."},"item_id":{"type":"string","example":"item_OcThl0eqYyTVQzll6qFrMDMBYyu","description":"Unique identifier for the item this option belongs to."},"name":{"type":"string","example":"Color","description":"The name of the item option."},"record_created_at":{"type":"string","format":"date-time","example":"2024-01-15T10:30:00Z","description":"ISO 8601 timestamp when the record was created."},"record_updated_at":{"type":"string","format":"date-time","example":"2024-01-15T15:45:00Z","description":"ISO 8601 timestamp when the record was last updated."},"required":{"type":"boolean","example":true,"description":"Whether this option is required to be selected."},"sort_order":{"type":"integer","example":1,"description":"Display order for this option relative to other options."}}},"ItemTierCreateRequest":{"type":"object","description":"Used to create a new item tier in the system.","properties":{"cost_decimal":{"type":"string","example":"25.99","description":"Cost of the item at this tier level as a decimal string."},"cost_type":{"type":"string","example":"amount","description":"Type of cost calculation (amount, percentage, etc.)."},"item_id":{"type":"string","example":"item_OcThl0eqYyTVQzll6qFrMDMBYyu","description":"Unique identifier for the item this tier belongs to."},"lower_boundary":{"type":"integer","example":10,"description":"Minimum quantity threshold for this pricing tier."},"price_decimal":{"type":"string","example":"49.99","description":"Price of the item at this tier level as a decimal string."}},"required":["item_id"]},"ItemTierList":{"type":"object","description":"A list of item tiers available in the system.","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ItemTier"},"description":"Array of item tier objects."},"next_cursor":{"type":"string","nullable":true,"example":"WyIzIl0=","description":"Base64-encoded cursor for the next page of results. Null if no more results."},"total_count":{"type":"integer","example":1,"description":"Total number of item tiers returned by the query."}}},"ItemTierUpdateRequest":{"type":"object","description":"Used to update the details of an existing item tier.","properties":{"cost_decimal":{"type":"string","example":"25.99","description":"Cost of the item at this tier level as a decimal string."},"cost_type":{"type":"string","example":"amount","description":"Type of cost calculation (amount, percentage, etc.)."},"lower_boundary":{"type":"integer","example":10,"description":"Minimum quantity threshold for this pricing tier."},"price_decimal":{"type":"string","example":"49.99","description":"Price of the item at this tier level as a decimal string."}}},"ItemTier":{"type":"object","description":"Represents a pricing tier for an item based on quantity thresholds.","properties":{"cost_decimal":{"type":"string","example":"25.99","description":"Cost of the item at this tier level as a decimal string."},"cost_type":{"type":"string","example":"amount","description":"Type of cost calculation (amount, percentage, etc.)."},"id":{"type":"string","example":"itier_OcThl8SOeE8w6JYUznfrnQGdp94","description":"Unique identifier for the item tier."},"item_id":{"type":"string","example":"item_OcThl0eqYyTVQzll6qFrMDMBYyu","description":"Unique identifier for the item this tier belongs to."},"lower_boundary":{"type":"integer","example":10,"description":"Minimum quantity threshold for this pricing tier."},"price_decimal":{"type":"string","example":"49.99","description":"Price of the item at this tier level as a decimal string."},"record_created_at":{"type":"string","format":"date-time","example":"2024-01-15T10:30:00Z","description":"ISO 8601 timestamp when the record was created."},"record_updated_at":{"type":"string","format":"date-time","example":"2024-01-15T15:45:00Z","description":"ISO 8601 timestamp when the record was last updated."}}},"ItemCreateRequest":{"type":"object","description":"Used to create a new item in the system.","properties":{"allow_decimal_quantities":{"type":"boolean","example":true,"description":"Whether the item can be sold in fractional quantities."},"category":{"type":"string","example":"SSDs","description":"Name of the category to which the item belongs. Required; cannot be provided with category_id."},"category_id":{"type":"string","example":"cat_OcThl8SOeE8w6JYUznfrnQGdp94","description":"ID of the category to which the item belongs. Required; cannot be provided with category."},"code":{"type":"string","example":"MZ-V7S1T0B/AM","description":"Custom reference code for the item."},"cost_decimal":{"type":"string","example":50.5,"description":"Unit cost of the item as a decimal. If provided, pricing_scheme must be flat, per_unit, or percentage."},"cost_type":{"type":"string","enum":["amount","percentage"],"example":"amount","description":"Type of cost (e.g., amount, percentage), used to interpret the cost value. If provided, pricing_scheme must be flat, per_unit, or percentage; required if cost is provided. Defaults to amount if not specified."},"description":{"type":"string","example":"The 970 EVO Plus reaches sequential read/write speeds up to 3,500/3,300 MB/s, up to 53% faster than the 970 EVO.","description":"Textual description of the item."},"internal_note":{"type":"string","example":"Check warehouse for inventory before ordering.","description":"Private notes about the item, not visible to customers."},"manufacturer":{"type":"string","example":"Samsung","description":"Name of the item's manufacturer. Cannot be provided with manufacturer_id."},"manufacturer_id":{"type":"string","example":"manu_OcThlEWcbhAG52u3vLJodwnV88k","description":"Unique ID of the manufacturer. Cannot be provided with manufacturer."},"name":{"type":"string","example":"SAMSUNG 970 EVO PLUS M.2 2280 1TB PCIe Gen 3.0 x4","description":"Name of the item being created."},"percentage_price_category_ids":{"type":"array","items":{"type":"string"},"description":"Category IDs used for percentage-based pricing. If provided, pricing_scheme must be percentage; required if pricing_scheme is percentage.","example":["cat_OcThlTV6Tama8RH5Zh4Jfw1fhJC"]},"percentage_price_decimal":{"type":"string","example":50.5,"description":"The percentage markup or markdown used in pricing. If provided, pricing_scheme must be percentage; required if pricing scheme is percentage."},"price_decimal":{"type":"string","example":50.5,"description":"Price of the item in decimal format. If provided, pricing_scheme must be flat or per_unit; validate decimal."},"pricing_scheme":{"type":"string","enum":["per_unit","flat","tiered_volume","tiered_stepped","percentage"],"example":"per_unit","description":"Method used for pricing, such as flat, per_unit, or percentage. Defaults to per_unit if omitted."},"quantity_help_tip":{"type":"string","example":"Enter the number of units required.","description":"Help text to guide users on how to select quantity."},"recurring":{"type":"boolean","example":true,"description":"Indicates whether the item is billed on a recurring basis."},"recurring_interval":{"type":"string","example":"annually","enum":["monthly","quarterly","semi_annually","annually"],"description":"Time interval for recurring billing (e.g., monthly, yearly). If provided, recurring must be true; required if recurring is true."},"restrict_discounting":{"type":"boolean","example":true,"description":"Prevents discounts from being applied to this item."},"show_option_prices":{"type":"boolean","example":true,"description":"Indicates whether option prices should be displayed alongside item price."},"sku":{"type":"string","example":"N82E16820147743","description":"Unique product code used for tracking inventory."},"supplier":{"type":"string","example":"Newegg","description":"Name of the item's supplier. Cannot be provided with supplier_id."},"supplier_id":{"type":"string","example":"sup_OcThlLwzLAM7m5eK1WEKkXUQZtm","description":"ID of the item's supplier. Cannot be provided with supplier."},"taxable":{"type":"boolean","example":true,"description":"Whether the item is subject to tax. Defaults to true if omitted."},"weight_decimal":{"type":"string","example":50.5,"description":"Item weight in decimal format."}},"required":["category_id","name"]},"ItemList":{"type":"object","description":"A list of items available in the system.","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Item"},"description":"Array of item objects."},"next_cursor":{"type":"string","nullable":true,"example":"WyIzIl0=","description":"Base64-encoded cursor for the next page of results. Null if no more results."},"total_count":{"type":"integer","example":1,"description":"Total number of items returned by the query."}}},"ItemUpdateRequest":{"type":"object","description":"Used to update the details of an existing item.","properties":{"allow_decimal_quantities":{"type":"boolean","example":true,"description":"Whether fractional quantities are allowed when selling this item."},"category":{"type":"string","example":"SSDs","description":"Name of the item's category. Cannot be provided with category_id."},"category_id":{"type":"string","example":"cat_OcThl8SOeE8w6JYUznfrnQGdp94","description":"Unique ID of the category. Cannot be provided with category."},"code":{"type":"string","example":"MZ-V7S1T0B/AM","description":"Custom item code."},"cost_decimal":{"type":"string","example":50.5,"description":"Unit cost expressed as a decimal. If provided, pricing_scheme must be flat, per_unit, or percentage."},"cost_type":{"type":"string","enum":["amount","percentage"],"example":"amount","description":"Indicates how to interpret the item's cost (e.g., flat, percentage). If provided, pricing_scheme must be flat, per_unit, or percentage; required if cost is provided. Defaults to amount if an empty value is specified."},"description":{"type":"string","example":"The 970 EVO Plus reaches sequential read/write speeds up to 3,500/3,300 MB/s, up to 53% faster than the 970 EVO.","description":"Item description."},"internal_note":{"type":"string","example":"Check warehouse for inventory before ordering.","description":"Notes for internal use."},"manufacturer":{"type":"string","example":"Samsung","description":"Name of the item's manufacturer. Cannot be provided with manufacturer_id."},"manufacturer_id":{"type":"string","example":"manu_OcThlEWcbhAG52u3vLJodwnV88k","description":"Unique ID of the manufacturer. Cannot be provided with manufacturer."},"name":{"type":"string","example":"SAMSUNG 970 EVO PLUS M.2 2280 1TB PCIe Gen 3.0 x4","description":"Name of the item."},"percentage_price_category_ids":{"type":"array","items":{"type":"string"},"description":"List of category IDs for percentage-based pricing. If provided, pricing_scheme must be percentage; required if pricing_scheme is percentage.","example":["cat_OcThlTV6Tama8RH5Zh4Jfw1fhJC"]},"percentage_price_decimal":{"type":"string","example":50.5,"description":"Percentage used for pricing. If provided, pricing_scheme must be percentage; required if pricing scheme is percentage."},"price_decimal":{"type":"string","example":50.5,"description":"Unit price of the item. If provided, pricing_scheme must be flat or per_unit; validate decimal."},"pricing_scheme":{"type":"string","enum":["per_unit","flat","tiered_volume","tiered_stepped","percentage"],"example":"per_unit","description":"The method used to calculate the item's price. Defaults to per_unit if omitted."},"quantity_help_tip":{"type":"string","example":"Enter the number of units required.","description":"Tooltip or help text related to quantity selection."},"recurring":{"type":"boolean","example":true,"description":"Whether the item is billed on a recurring schedule."},"recurring_interval":{"type":"string","example":"annually","enum":["monthly","quarterly","semi_annually","annually"],"description":"Billing interval for recurring items. If provided, recurring must be true; required if recurring is true."},"restrict_discounting":{"type":"boolean","example":true,"description":"Disables discounts on the item."},"show_option_prices":{"type":"boolean","example":true,"description":"Whether to display option prices next to the base price."},"sku":{"type":"string","example":"N82E16820147743","description":"Stock keeping unit for inventory tracking."},"supplier":{"type":"string","example":"Newegg","description":"Name of the supplier. Cannot be provided with supplier_id."},"supplier_id":{"type":"string","example":"sup_OcThlLwzLAM7m5eK1WEKkXUQZtm","description":"ID of the supplier. Cannot be provided with supplier."},"taxable":{"type":"boolean","example":true,"description":"Indicates whether the item is taxable. Defaults to true if omitted."},"weight_decimal":{"type":"string","example":50.5,"description":"Item weight in decimal format."}}},"Item":{"type":"object","description":"Represents a product or service available for quoting.","properties":{"allow_decimal_quantities":{"type":"boolean","example":true,"description":"Whether the item can be sold in fractional quantities."},"category":{"type":"string","example":"SSDs","description":"Name of the category to which the item belongs."},"category_id":{"type":"string","example":"cat_OcThl8SOeE8w6JYUznfrnQGdp94","description":"ID of the category to which the item belongs."},"code":{"type":"string","example":"MZ-V7S1T0B/AM","description":"Code used to reference the item. Also referred to as \"MPN\" in Quoter's UI. Should be unique."},"cost_decimal":{"type":"string","example":50.5,"description":"Unit cost of the item in decimal format."},"cost_type":{"type":"string","enum":["amount","percentage"],"example":"amount","description":"Indicates the type of cost (e.g., amount, percent)."},"description":{"type":"string","example":"The 970 EVO Plus reaches sequential read/write speeds up to 3,500/3,300 MB/s, up to 53% faster than the 970 EVO.","description":"Description of the item, HTML formatting is supported."},"id":{"type":"string","example":"item_OcThl0eqYyTVQzll6qFrMDMBYyu","description":"Unique identifier for the item."},"internal_note":{"type":"string","example":"Check warehouse for inventory before ordering.","description":"Internal notes about the item, not shown to customers."},"manufacturer":{"type":"string","example":"Samsung","description":"Name of the item manufacturer."},"manufacturer_id":{"type":"string","example":"manu_OcThlEWcbhAG52u3vLJodwnV88k","description":"Unique identifier for the manufacturer."},"name":{"type":"string","example":"SAMSUNG 970 EVO PLUS M.2 2280 1TB PCIe Gen 3.0 x4","description":"The name of the item."},"percentage_price_category_ids":{"type":"array","items":{"type":"string"},"example":["cat_OcThlTV6Tama8RH5Zh4Jfw1fhJC"],"description":"Category IDs used to calculate percentage-based pricing."},"percentage_price_decimal":{"type":"string","example":50.5,"description":"Percentage value used for pricing if applicable."},"price_decimal":{"type":"string","example":50.5,"description":"Price of the item in decimal format."},"pricing_scheme":{"type":"string","enum":["per_unit","flat","tiered_volume","tiered_stepped","percentage"],"example":"per_unit","description":"Pricing scheme for the item."},"quantity_help_tip":{"type":"string","example":"Enter the number of units required.","description":"Optional help text to assist in selecting a quantity."},"record_created_at":{"type":"string","format":"date-time","example":"2024-01-15T10:30:00Z","description":"ISO 8601 timestamp when the record was created."},"record_updated_at":{"type":"string","format":"date-time","example":"2024-01-15T15:45:00Z","description":"ISO 8601 timestamp when the record was last updated."},"recurring":{"type":"boolean","example":true,"description":"Indicates if the item is billed on a recurring basis."},"recurring_interval":{"type":"string","example":"annually","enum":["monthly","quarterly","semi_annually","annually"],"description":"Billing interval if the item is recurring."},"restrict_discounting":{"type":"boolean","example":true,"description":"Whether discounting is disabled for this item."},"show_option_prices":{"type":"boolean","example":true,"description":"Indicates if option prices should be displayed."},"sku":{"type":"string","example":"N82E16820147743","description":"Stock keeping unit identifier for the item."},"supplier":{"type":"string","example":"Newegg","description":"Name of the item's supplier."},"supplier_id":{"type":"string","example":"sup_OcThlLwzLAM7m5eK1WEKkXUQZtm","description":"Unique identifier for the supplier."},"taxable":{"type":"boolean","example":true,"description":"Indicates whether the item is subject to tax."},"weight_decimal":{"type":"string","example":50.5,"description":"Item weight in decimal format."}}},"ManufacturerCreateRequest":{"type":"object","description":"Used to create a new manufacturer in the system.","properties":{"name":{"type":"string","example":"Apple","description":"The name of the manufacturer."}},"required":["name"]},"ManufacturerList":{"type":"object","description":"A list of manufacturers available in the system.","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Manufacturer"},"description":"Array of manufacturer objects."},"next_cursor":{"type":"string","nullable":true,"example":"WyIzIl0=","description":"Base64-encoded cursor for the next page of results. Null if no more results."},"total_count":{"type":"integer","example":1,"description":"Total number of manufacturers returned by the query."}}},"ManufacturerUpdateRequest":{"type":"object","description":"Used to update the details of an existing manufacturer.","properties":{"name":{"type":"string","example":"Apple","description":"The name of the manufacturer."}}},"Manufacturer":{"type":"object","description":"Represents a manufacturer of items.","properties":{"id":{"type":"string","example":"mfg_OcThl8SOeE8w6JYUznfrnQGdp94","description":"Unique identifier for the manufacturer."},"name":{"type":"string","example":"Apple","description":"The name of the manufacturer."},"record_created_at":{"type":"string","format":"date-time","example":"2024-01-15T10:30:00Z","description":"ISO 8601 timestamp when the record was created."},"record_updated_at":{"type":"string","format":"date-time","example":"2024-01-15T15:45:00Z","description":"ISO 8601 timestamp when the record was last updated."}}},"SupplierCreateRequest":{"type":"object","description":"Used to create a new supplier in the system.","properties":{"name":{"type":"string","example":"Global Supply Co","description":"The name of the supplier."}},"required":["name"]},"SupplierList":{"type":"object","description":"A list of suppliers available in the system.","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Supplier"},"description":"Array of supplier objects."},"next_cursor":{"type":"string","nullable":true,"example":"WyIzIl0=","description":"Base64-encoded cursor for the next page of results. Null if no more results."},"total_count":{"type":"integer","example":1,"description":"Total number of suppliers returned by the query."}}},"SupplierUpdateRequest":{"type":"object","description":"Used to update the details of an existing supplier.","properties":{"name":{"type":"string","example":"Global Supply Co","description":"The name of the supplier."}}},"Supplier":{"type":"object","description":"Represents a supplier of items.","properties":{"id":{"type":"string","example":"sup_OcThl8SOeE8w6JYUznfrnQGdp94","description":"Unique identifier for the supplier."},"name":{"type":"string","example":"Global Supply Co","description":"The name of the supplier."},"record_created_at":{"type":"string","format":"date-time","example":"2024-01-15T10:30:00Z","description":"ISO 8601 timestamp when the record was created."},"record_updated_at":{"type":"string","format":"date-time","example":"2024-01-15T15:45:00Z","description":"ISO 8601 timestamp when the record was last updated."}}},"DatafeedsSupplierItemList":{"type":"object","description":"A list of supplier feed items with cursor-based pagination and filtering support.","required":["data","next_cursor","total_count"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DatafeedsSupplierItem"},"description":"Array of data feed supplier item objects."},"next_cursor":{"type":"string","nullable":true,"example":"WyIzIl0=","description":"Base64 encoded cursor for the next page of results. Null when no more results are available.\n"},"total_count":{"type":"integer","example":1,"description":"Total number of items in the feed matching the filter criteria."}}},"DatafeedsSupplierItem":{"type":"object","description":"Represents an item within a supplier's data feed.","required":["category","id","mpn","name","price_amount_decimal","record_created_at","record_updated_at","semantic_item_id","sku","supplier_default_taxable","supplier_id","supplier_name","taxable","warehouses","weight_decimal"],"properties":{"category":{"type":"string","example":"Networking","description":"The name of the category associated with this item."},"id":{"type":"string","example":"sitm_2tdpIVSQAR8jy5nILOG9QBJYBdF","description":"Unique identifier for the item within the data feed."},"mpn":{"type":"string","example":"AW30004","description":"Manufacturer part number for the item."},"name":{"type":"string","example":"Cisco Catalyst Switch","description":"Display name of the item."},"price_amount_decimal":{"type":"string","example":"1202.50","description":"The item's price as a decimal string."},"record_created_at":{"type":"string","format":"date-time","example":"2024-01-15T10:30:00Z","description":"Timestamp indicating when the supplier item record was created."},"record_updated_at":{"type":"string","format":"date-time","example":"2024-01-15T15:45:00Z","description":"Timestamp indicating when the supplier item record was last updated."},"semantic_item_id":{"type":"string","example":"smitm_2tUylOc8T55BoUDtwLMbTY4Sj1x","description":"An internal ID representing a semantic match for the item."},"sku":{"type":"string","example":"UP16C236ZZNEAA","description":"The stock keeping unit assigned by the supplier."},"supplier_default_taxable":{"type":"boolean","example":true,"description":"Whether the item is taxable by the supplier's default rule."},"supplier_id":{"type":"string","example":"supp_2tUykybikauznOTjgNzGPq0KFkz","description":"Unique identifier of the supplier providing the item."},"supplier_name":{"type":"string","example":"Network Solutions Inc","description":"Name of the supplier providing the item."},"taxable":{"type":"boolean","example":true,"description":"Whether the item is marked as taxable in the feed."},"warehouses":{"type":"array","items":{"$ref":"#/components/schemas/SupplierItemWarehouse"},"description":"Array of warehouse stock data for the item."},"weight_decimal":{"type":"string","example":"1000.00","description":"Item weight in decimal format."}}},"SupplierItemWarehouse":{"type":"object","description":"Represents a warehouse and its available inventory for a supplier item.","required":["id","name","quantity"],"properties":{"id":{"type":"string","example":"itmw_2tdpIbLafl0Big0WPgsTbVt1BFa","description":"Unique identifier for the warehouse."},"name":{"type":"string","example":"Warehouse1","description":"Name of the warehouse."},"quantity":{"type":"string","example":"20","description":"Quantity of items currently in stock at the warehouse."}}},"DatafeedsSupplierList":{"type":"object","description":"A list of all configured supplier data feeds with cursor-based pagination.","required":["data","next_cursor","total_count"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DatafeedsSupplier"},"description":"Array of data feed supplier objects."},"next_cursor":{"type":"string","nullable":true,"example":"WyIzIl0=","description":"Base64 encoded cursor for the next page of results. Null when no more results are available.\n"},"total_count":{"type":"integer","example":1,"description":"Total number of supplier feeds available."}}},"DatafeedsSupplier":{"type":"object","description":"Defines a supplier that provides external product data feeds.","required":["default_taxable","field_mapping","id","name","record_created_at","record_updated_at","url"],"properties":{"default_taxable":{"type":"boolean","example":true,"description":"Indicates whether items from this supplier are taxable by default."},"field_mapping":{"$ref":"#/components/schemas/SupplierFieldMapping"},"id":{"type":"string","example":"supp_2uBmQcMgHinlJgyv4or3dCKwWIb","description":"Unique identifier for the data feed supplier."},"name":{"type":"string","example":"Apple Distributor","description":"The display name of the supplier feed."},"record_created_at":{"type":"string","format":"date-time","example":"2024-01-15T10:30:00Z","description":"Timestamp indicating when the supplier feed was created."},"record_updated_at":{"type":"string","format":"date-time","example":"2024-01-15T15:45:00Z","description":"Timestamp indicating the last modification of the feed."},"url":{"type":"string","example":"https://apple-feed.example.com/catalog.csv","description":"The URL of the data feed provided by the supplier."}}},"SupplierFieldMapping":{"type":"object","description":"Maps supplier CSV fields to internal schema fields.","required":["category_name","manufacturer","mpn","name","price","supplier_sku","warehouses","weight"],"properties":{"category_name":{"type":"string","example":"csvheader4","description":"The supplier's field name for the product category."},"manufacturer":{"type":"string","example":"csvheader3","description":"The supplier's field name for the product manufacturer."},"mpn":{"type":"string","example":"csvheader1","description":"The supplier's field name for the manufacturer part number."},"name":{"type":"string","example":"csvheader2","description":"The supplier's field name for the product name."},"price":{"type":"string","example":"csvheader6","description":"The supplier's field name for the product price."},"supplier_sku":{"type":"string","example":"csvheader5","description":"The supplier's field name for the SKU."},"taxable":{"type":"string","nullable":true,"example":"csvheader8","description":"The supplier's field name indicating whether the item is taxable."},"warehouses":{"type":"array","items":{"$ref":"#/components/schemas/SupplierWarehouseMapping"},"description":"The supplier's field mapping for warehouse inventory."},"weight":{"type":"string","example":"csvheader7","description":"The supplier's field name for the product weight."}}},"SupplierWarehouseMapping":{"type":"object","description":"Maps warehouse data from supplier feeds to internal structures.","required":["name","quantity"],"properties":{"name":{"type":"string","example":"wh1","description":"Name of the warehouse used in supplier data feeds."},"quantity":{"type":"string","example":"wh1_qty","description":"Quantity field name for stock available in that warehouse from the supplier's feed."}}}},"responses":{"LineItemStatusCode201Create":{"description":"Line item created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LineItem"}}}},"QuoteTemplateStatusCode200List":{"description":"Quote Templates found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuoteTemplateList"}}}},"QuoteStatusCode200List":{"description":"Quotes found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuoteList"}}}},"StatusCode204":{"description":"Success, no content."},"StatusCode204Deleted":{"description":"Record deleted."},"StatusCode404":{"description":"Record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse404"}}}},"StatusCode422":{"description":"Unprocessable Entity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"CategoryStatusCode201Created":{"description":"Category created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Category"}}}},"CategoryStatusCode200":{"description":"Category found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Category"}}}},"CategoryStatusCode200List":{"description":"Categories found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryList"}}}},"CategoryStatusCode200Updated":{"description":"Category updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Category"}}}},"ItemGroupAssignmentStatusCode201Created":{"description":"Item Group Assignment created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemGroupAssignment"}}}},"ItemGroupAssignmentStatusCode200":{"description":"Item Group Assignment found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemGroupAssignment"}}}},"ItemGroupAssignmentStatusCode200List":{"description":"Item Group Assignments found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemGroupAssignmentList"}}}},"ItemGroupStatusCode201Created":{"description":"Item Group created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemGroup"}}}},"ItemGroupStatusCode200":{"description":"Item Group found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemGroup"}}}},"ItemGroupStatusCode200List":{"description":"Item Groups found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemGroupList"}}}},"ItemGroupStatusCode200Updated":{"description":"Item Group updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemGroup"}}}},"ItemOptionValueStatusCode201Created":{"description":"Item Option Value created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemOptionValue"}}}},"ItemOptionValueStatusCode200":{"description":"Item Option Value found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemOptionValue"}}}},"ItemOptionValueStatusCode200List":{"description":"Item Option Values found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemOptionValueList"}}}},"ItemOptionValueStatusCode200Updated":{"description":"Item Option Value updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemOptionValue"}}}},"ItemOptionStatusCode201Created":{"description":"Item Option created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemOption"}}}},"ItemOptionStatusCode200":{"description":"Item Option found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemOption"}}}},"ItemOptionStatusCode200List":{"description":"Item Options found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemOptionList"}}}},"ItemOptionStatusCode200Updated":{"description":"Item Option updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemOption"}}}},"ItemTierStatusCode201Created":{"description":"Item Tier created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemTier"}}}},"ItemTierStatusCode200":{"description":"Item Tier found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemTier"}}}},"ItemTierStatusCode200List":{"description":"Item Tiers found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemTierList"}}}},"ItemTierStatusCode200Updated":{"description":"Item Tier updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemTier"}}}},"ItemStatusCode201Created":{"description":"Item created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Item"}}}},"ItemStatusCode200":{"description":"Item found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Item"}}}},"ItemStatusCode200List":{"description":"Items found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemList"}}}},"ItemStatusCode200Updated":{"description":"Item updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Item"}}}},"ManufacturerStatusCode201Created":{"description":"Manufacturer created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Manufacturer"}}}},"ManufacturerStatusCode200":{"description":"Manufacturer found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Manufacturer"}}}},"ManufacturerStatusCode200List":{"description":"Manufacturers found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManufacturerList"}}}},"ManufacturerStatusCode200Updated":{"description":"Manufacturer updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Manufacturer"}}}},"SupplierStatusCode201Created":{"description":"Supplier created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Supplier"}}}},"SupplierStatusCode200":{"description":"Supplier found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Supplier"}}}},"SupplierStatusCode200List":{"description":"Suppliers found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierList"}}}},"SupplierStatusCode200Updated":{"description":"Supplier updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Supplier"}}}},"DatafeedsSupplierItemListStatusCode200":{"description":"Supplier Items found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatafeedsSupplierItemList"},"examples":{"supplier_items_found":{"summary":"Supplier items found with cursor pagination","value":{"data":[{"category":"Networking","id":"sitm_2tdpIVSQAR8jy5nILOG9QBJYBdF","mpn":"AW30004","name":"Cisco Catalyst Switch","price_amount_decimal":"1202.50","record_created_at":"2024-01-15T10:30:00Z","record_updated_at":"2024-01-15T15:45:00Z","semantic_item_id":"smitm_2tUylOc8T55BoUDtwLMbTY4Sj1x","sku":"UP16C236ZZNEAA","supplier_default_taxable":true,"supplier_id":"supp_2tUykybikauznOTjgNzGPq0KFkz","supplier_name":"Network Solutions Inc","taxable":true,"warehouses":[{"id":"itmw_2tdpIbLafl0Big0WPgsTbVt1BFa","name":"Warehouse1","quantity":"20"}],"weight_decimal":"1000.00"}],"next_cursor":null,"total_count":1}}}}}},"StatusCode400":{"description":"Bad Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"missing_mpns":{"summary":"Missing MPN filter parameter","value":{"message":"MPN filter parameter is required"}}}}}},"DatafeedsSupplierListStatusCode200":{"description":"Suppliers found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatafeedsSupplierList"},"examples":{"suppliers_found":{"summary":"Suppliers found with cursor pagination","value":{"data":[{"default_taxable":true,"field_mapping":{"category_name":"csvheader4","manufacturer":"csvheader3","mpn":"csvheader1","name":"csvheader2","price":"csvheader6","supplier_sku":"csvheader5","taxable":"csvheader8","warehouses":[{"name":"wh1","quantity":"wh1_qty"}],"weight":"csvheader7"},"id":"supp_2uBmQcMgHinlJgyv4or3dCKwWIb","name":"Apple Distributor","record_created_at":"2024-01-15T10:30:00Z","record_updated_at":"2024-01-15T15:45:00Z","url":"https://apple-feed.example.com/catalog.csv"}],"next_cursor":null,"total_count":1}}}}}}},"parameters":{"QuoteTemplateQueryListSort":{"in":"query","name":"sort","schema":{"type":"string","example":"title,id","enum":["-record_created_at","-id","-record_updated_at","-title","+record_created_at","+id","+record_updated_at","+title"]},"description":"One or more sort fields, separated by commas."},"QueryListCursor":{"description":"Cursor for pagination (from previous response's next_cursor).","in":"query","name":"cursor","schema":{"type":"string","example":"WyIzIl0="}},"QueryListPageSize":{"description":"The number of records to be returned in a single page","in":"query","name":"page_size","schema":{"type":"integer","format":"int32"}},"QuoteTemplateQueryListFilterByTitle":{"in":"query","name":"filter[title]","schema":{"type":"string"},"description":"Filter by **title**.\n\n**Operators:** `cont`\n\n**Examples**\n- `filter[title]=cont:Business`\n- `filter[title]=cont:Template`\n"},"QuoteQueryListSort":{"in":"query","name":"sort","schema":{"type":"string","example":"name,id","enum":["-record_created_at","-expired_at","-id","-record_updated_at","-name","-won_at","+record_created_at","+expired_at","+id","+record_updated_at","+name","+won_at"]},"description":"One or more sort fields, separated by commas."},"QueryListFilterByRecordCreatedAt":{"description":"Filter by **record_created_at**.\n\n**Operators:** `gt`, `lt`\n\n**Examples**\n- `filter[record_created_at]=gt:2023-01-01T00:00:00Z`\n- `filter[record_created_at]=lt:2025-01-01T00:00:00Z`\n","in":"query","name":"filter[record_created_at]","schema":{"type":"string"}},"QueryListFilterByRecordUpdatedAt":{"description":"Filter by **record_updated_at**.\n\n**Operators:** `gt`, `lt`\n\n**Examples**\n- `filter[record_updated_at]=gt:2023-01-01T00:00:00Z`\n- `filter[record_updated_at]=lt:2025-01-01T00:00:00Z`\n","in":"query","name":"filter[record_updated_at]","schema":{"type":"string"}},"QueryListFilterByExpiredAt":{"in":"query","name":"filter[expired_at]","schema":{"type":"string"},"description":"Filter by **expired_at**.\n\n**Operators:** `gt`, `lt`\n\n**Examples**\n- `filter[expired_at]=gt:2023-01-01T00:00:00Z`\n- `filter[expired_at]=lt:2025-01-01T00:00:00Z`\n"},"QueryListFilterWonAt":{"in":"query","name":"filter[won_at]","schema":{"type":"string"},"description":"Filter by **won_at**.\n\n**Operators:** `gt`, `lt`\n\n**Examples**\n- `filter[won_at]=gt:2023-01-01T00:00:00Z`\n- `filter[won_at]=lt:2025-01-01T00:00:00Z`\n"},"QuoteQueryListFilterByCustomNumber":{"in":"query","name":"filter[custom_number]","schema":{"type":"string"},"description":"Filter by **custom_number**.\n\n**Operators:** `cont`\n\n**Examples**\n- `filter[custom_number]=cont:100`\n"},"QuoteQueryListFilterByDraft":{"in":"query","name":"filter[draft]","schema":{"type":"boolean"},"description":"Filter by **draft**.\n\n**Operators:** `eq`\n\n**Examples**\n- `filter[draft]=eq:true`\n"},"QuoteQueryListFilterByEmailStatus":{"in":"query","name":"filter[email_status]","schema":{"type":"string","enum":["bounced","clicked","deferred","delivered","dropped","opened","processed","reported_as_spam","sent","unsubscribed"]},"description":"Filter by **email_status**. Accepts a single value.\n\n**Operators:** `eq`\n\n**Examples**\n- `filter[email_status]=eq:sent`\n- `filter[email_status]=eq:delivered`\n- `filter[email_status]=eq:clicked`\n"},"QuoteQueryListFilterByIDs":{"in":"query","name":"filter[id]","schema":{"type":"string"},"description":"Filter by **id**.\n\n**Operators:** `in`\n\n**Examples**\n- `filter[id]=in:quot_1,quot_2`\n"},"QuoteQueryListFilterByLMInitiativeID":{"in":"query","name":"filter[lm_initiative_id]","schema":{"type":"string"},"description":"Filter by **lm_initiative_id**.\n\n**Operators:** `eq`\n\n**Examples**\n- `filter[lm_initiative_id]=eq:62f89f6e-38d6-423f-b567-b4d95de859e5`\n"},"QuoteQueryListFilterByName":{"in":"query","name":"filter[name]","schema":{"type":"string"},"description":"Filter by **name**.\n\n**Operators:** `eq`, `cont`\n\n**Examples**\n- `filter[name]=eq:abba`\n- `filter[name]=cont:ab`\n"},"QuoteQueryListFilterByPrimary":{"in":"query","name":"filter[primary]","schema":{"type":"boolean"},"description":"Filter by **primary**.\n\n**Operators:** `eq`\n\n**Examples**\n- `filter[primary]=eq:true`\n"},"QuoteQueryListFilterByRecurringInterval":{"in":"query","name":"filter[recurring_interval]","schema":{"type":"string"},"description":"Filter by **recurring_interval**.\n\n**Operators:** `eq`\n\n**Examples**\n- `filter[recurring_interval]=eq:monthly`\n"},"QuoteQueryListFilterByStage":{"in":"query","name":"filter[stage]","schema":{"type":"array","items":{"type":"string","enum":["draft","expired","lost","published","sent-clicked","sent-delivered","sent-opened","sent-pending","sent-undeliverable","won-accepted","won-fulfilled","won-ordered"]}},"style":"form","explode":false,"description":"Filter by **stage**. Accepts multiple comma-separated values.\n\n**Operators:** `in`\n\n**Examples**\n- `filter[stage]=in:published,won-fulfilled,won-ordered,draft`\n"},"QuoteQueryListFilterByClientID":{"in":"query","name":"filter[client.id]","schema":{"type":"string"},"description":"Filter by **client.id**.\n\n**Operators:** `eq`\n\n**Examples**\n- `filter[client.id]=eq:03840c4b-5999-49ac-80b6-0e6000a758fd`\n"},"QuoteQueryListFilterByUUID":{"in":"query","name":"filter[uuid]","schema":{"type":"string"},"description":"Filter by **uuid**.\n\n**Operators:** `eq`\n\n**Examples**\n- `filter[uuid]=eq:123e4567-e89b-12d3-a456-426614174000`\n"},"HeaderApiKeyAccess":{"in":"header","name":"x-api-key","schema":{"type":"string"},"description":"API key for authentication","example":"your-api-key-here","required":true},"QueryListFields":{"in":"query","name":"fields","schema":{"type":"array","items":{"properties":{"fields":{"type":"string"}}}},"description":"One or more field separated by commas."},"QueryListSortBy":{"in":"query","name":"sort_by","schema":{"type":"string"},"description":"One or more field separated by commas."},"QueryListFilterByCreatedAt":{"in":"query","name":"filter[created_at]","schema":{"type":"string"},"description":"Filter by **created_at**.\n\n**Operators:** `gt`, `lt`\n\n**Examples**\n- `filter[created_at]=gt:2023-01-01T00:00:00Z`\n- `filter[created_at]=lt:2025-01-01T00:00:00Z`\n"},"QueryListFilterByModifiedAt":{"in":"query","name":"filter[modified_at]","schema":{"type":"string"},"description":"Filter by **modified_at**.\n\n**Operators:** `gt`, `lt`\n\n**Examples**\n- `filter[modified_at]=gt:2023-01-01T00:00:00Z`\n- `filter[modified_at]=lt:2025-01-01T00:00:00Z`\n"},"QueryListFilterByName":{"in":"query","name":"filter[name]","schema":{"type":"string"},"description":"Filter by **name**.\n\n**Operators:** `eq`, `cont`\n\n**Examples**\n- `filter[name]=eq:abba`\n- `filter[name]=cont:ab`\n"},"QueryListLimit":{"in":"query","name":"limit","schema":{"type":"integer"},"description":"Limit the number of records to return. Limit ranges from 1 to 100, and defaults to 100."},"QueryListPage":{"in":"query","name":"page","schema":{"type":"integer"},"description":"Pagination record offset. Page starts at 1."},"CategoryQueryListSort":{"in":"query","name":"sort","schema":{"type":"string","example":"name,id","enum":["-record_created_at","-id","-record_updated_at","-name","-parent_category_id","+record_created_at","+id","+record_updated_at","+name","+parent_category_id"]},"description":"One or more sort fields, separated by commas."},"CategoryQueryListFilterByParentCategoryID":{"in":"query","name":"filter[parent_category_id]","schema":{"type":"string"},"description":"Filter records by those associated with **parent_category_id**.\n\n**Operators:** `eq`\n\n**Examples**\n- `filter[parent_category_id]=eq:cat_123`\n"},"CategoryQueryFields":{"in":"query","name":"fields","schema":{"type":"string","example":"id, name","enum":["id","name","parent_category","parent_category_id","record_created_at","record_updated_at"]},"description":"One or more response fields, separated by commas."},"ItemGroupAssignmentQueryListSort":{"in":"query","name":"sort","schema":{"type":"string","example":"item_group_id,id","enum":["-record_created_at","-id","-record_updated_at","-item_group_id","-item_id","+record_created_at","+id","+record_updated_at","+item_group_id","+item_id"]},"description":"One or more sort fields, separated by commas."},"ItemGroupAssignmentQueryListFilterByItemGroupID":{"in":"query","name":"filter[item_group_id]","schema":{"type":"string"},"description":"Filter records by those associated with **item_group_id**.\n\n**Operators:** `eq`\n\n**Examples**\n- `filter[item_group_id]=eq:igrp_123`\n"},"ItemGroupAssignmentQueryListFilterByItemID":{"in":"query","name":"filter[item_id]","schema":{"type":"string"},"description":"Filter records by those associated with **item_id**.\n\n**Operators:** `eq`\n\n**Examples**\n- `filter[item_id]=eq:item_123`\n"},"ItemGroupAssignmentQueryFields":{"in":"query","name":"fields","schema":{"type":"string","example":"id, item_group_id","enum":["id","item_group_id","item_id","record_created_at","record_updated_at"]},"description":"One or more response fields, separated by commas."},"ItemGroupQueryListSort":{"in":"query","name":"sort","schema":{"type":"string","example":"name,id","enum":["-record_created_at","-id","-record_updated_at","-name","+record_created_at","+id","+record_updated_at","+name"]},"description":"One or more sort fields, separated by commas."},"ItemGroupQueryFields":{"in":"query","name":"fields","schema":{"type":"string","example":"id, name","enum":["id","name","record_created_at","record_updated_at"]},"description":"One or more response fields, separated by commas."},"ItemOptionValueQueryListSort":{"in":"query","name":"sort","schema":{"type":"string","example":"name,id","enum":["-record_created_at","-id","-record_updated_at","-name","-sort_order","+record_created_at","+id","+record_updated_at","+name","+sort_order"]},"description":"One or more sort fields, separated by commas."},"ItemOptionValueQueryListFilterByCode":{"in":"query","name":"filter[code]","schema":{"type":"string"},"description":"Filter records by **code**.\n\n**Operators:** `eq`, `cont`\n\n**Examples**\n- `filter[code]=eq:COLOR_RED`\n- `filter[code]=cont:COLOR`\n"},"ItemOptionValueQueryListFilterByItemID":{"in":"query","name":"filter[item_id]","schema":{"type":"string"},"description":"Filter records by those associated with **item_id**.\n\n**Operators:** `eq`\n\n**Examples**\n- `filter[item_id]=eq:item_123`\n"},"ItemOptionValueQueryListFilterByItemOptionID":{"in":"query","name":"filter[item_option_id]","schema":{"type":"string"},"description":"Filter records by those associated with **item_option_id**.\n\n**Operators:** `eq`\n\n**Examples**\n- `filter[item_option_id]=eq:iopt_123`\n"},"ItemOptionValueQueryFields":{"in":"query","name":"fields","schema":{"type":"string","example":"id, name, code","enum":["code","cost_decimal","cost_type","id","item_id","item_option_id","name","price_decimal","pricing_scheme","record_created_at","record_updated_at","sort_order"]},"description":"One or more response fields, separated by commas."},"ItemOptionQueryListSort":{"in":"query","name":"sort","schema":{"type":"string","example":"name,id","enum":["-record_created_at","-id","-record_updated_at","-name","-sort_order","+record_created_at","+id","+record_updated_at","+name","+sort_order"]},"description":"One or more sort fields, separated by commas."},"ItemOptionQueryListFilterByItemID":{"in":"query","name":"filter[item_id]","schema":{"type":"string"},"description":"Filter records by those associated with **item_id**.\n\n**Operators:** `eq`\n\n**Examples**\n- `filter[item_id]=eq:item_123`\n"},"ItemOptionQueryFields":{"in":"query","name":"fields","schema":{"type":"string","example":"id, name","enum":["allow_multiple_values","description","extended_description","id","item_id","name","record_created_at","record_updated_at","required","sort_order"]},"description":"One or more response fields, separated by commas."},"ItemTierQueryListSort":{"in":"query","name":"sort","schema":{"type":"string","example":"lower_boundary,id","enum":["-id","-lower_boundary","-record_created_at","-record_updated_at","+id","+lower_boundary","+record_created_at","+record_updated_at"]},"description":"One or more sort fields, separated by commas."},"ItemTierQueryListFilterByItemID":{"in":"query","name":"filter[item_id]","schema":{"type":"string"},"description":"Filter records by those associated with **item_id**.\n\n**Operators:** `eq`\n\n**Examples**\n- `filter[item_id]=eq:item_123`\n"},"ItemTierQueryFields":{"in":"query","name":"fields","schema":{"type":"string","example":"id, item_id, lower_boundary","enum":["cost_decimal","cost_type","id","item_id","lower_boundary","price_decimal","record_created_at","record_updated_at"]},"description":"One or more response fields, separated by commas."},"ItemQueryListSort":{"in":"query","name":"sort","schema":{"type":"string","example":"name,id","enum":["-record_created_at","-id","-record_updated_at","-name","+record_created_at","+id","+record_updated_at","+name"]},"description":"One or more sort fields, separated by commas."},"ItemQueryListFilterByCategoryID":{"in":"query","name":"filter[category_id]","schema":{"type":"string"},"description":"Filter records by those associated with **category_id**.\n\n**Operators:** `eq`\n\n**Examples**\n- `filter[category_id]=eq:cat_123`\n"},"ItemQueryListFilterByManufacturerID":{"in":"query","name":"filter[manufacturer_id]","schema":{"type":"string"},"description":"Filter records by those associated with **manufacturer_id**.\n\n**Operators:** `eq`\n\n**Examples**\n- `filter[manufacturer_id]=eq:mfg_123`\n"},"ItemQueryListFilterBySupplierID":{"in":"query","name":"filter[supplier_id]","schema":{"type":"string"},"description":"Filter records by those associated with **supplier_id**.\n\n**Operators:** `eq`\n\n**Examples**\n- `filter[supplier_id]=eq:sup_123`\n"},"ItemQueryListFilterByCode":{"in":"query","name":"filter[code]","schema":{"type":"string"},"description":"Filter by **code**.\n\n**Operators:** `eq`\n\n**Examples**\n- `filter[code]=eq:ITEM001`\n"},"ItemQueryListFilterBySKU":{"in":"query","name":"filter[sku]","schema":{"type":"string"},"description":"Filter by **sku**.\n\n**Operators:** `eq`\n\n**Examples**\n- `filter[sku]=eq:WDG-PRO-001`\n"},"ItemQueryFields":{"in":"query","name":"fields","schema":{"type":"string","example":"id, name","enum":["allow_decimal_quantities","category","category_id","code","cost_decimal","cost_type","description","id","internal_note","manufacturer","manufacturer_id","name","percentage_price_category_ids","percentage_price_decimal","price_decimal","pricing_scheme","quantity_help_tip","record_created_at","record_updated_at","recurring","recurring_interval","restrict_discounting","show_option_prices","sku","supplier","supplier_id","taxable","weight_decimal"]},"description":"One or more response fields, separated by commas."},"ManufacturerQueryListSort":{"in":"query","name":"sort","schema":{"type":"string","example":"name,id","enum":["-record_created_at","-id","-record_updated_at","-name","+record_created_at","+id","+record_updated_at","+name"]},"description":"One or more sort fields, separated by commas."},"ManufacturerQueryFields":{"in":"query","name":"fields","schema":{"type":"string","example":"id, name","enum":["id","name","record_created_at","record_updated_at"]},"description":"One or more response fields, separated by commas."},"SupplierQueryListSort":{"in":"query","name":"sort","schema":{"type":"string","example":"name,id","enum":["-record_created_at","-id","-record_updated_at","-name","+record_created_at","+id","+record_updated_at","+name"]},"description":"One or more sort fields, separated by commas."},"SupplierQueryFields":{"in":"query","name":"fields","schema":{"type":"string","example":"id, name","enum":["id","name","record_created_at","record_updated_at"]},"description":"One or more response fields, separated by commas."},"DatafeedsSupplierItemQueryFilterMPN":{"in":"query","name":"filter[mpn]","required":true,"schema":{"type":"string","example":"cont:AW30004,AW30005","pattern":"^cont:.+$"},"description":"**Required.** Filter by **mpn**.\n\n**Operators:** `cont`\n\n**Examples**\n- `filter[mpn]=cont:AW30004,AW30005`\n\nNote: The `cont` operator supports multiple comma-separated MPNs.\nThis parameter is mandatory - requests without MPN filtering will return a 400 error.\n"},"QueryPageSize":{"in":"query","name":"page_size","schema":{"type":"integer","minimum":1,"maximum":200,"default":100,"example":50},"description":"Number of records to return per page."},"QueryCursor":{"in":"query","name":"cursor","schema":{"type":"string","example":"WyIzIl0="},"description":"Base64 encoded cursor for pagination. Omit for first page."},"DatafeedsSupplierQueryListSort":{"in":"query","name":"sort","schema":{"type":"string","example":"+name,-record_created_at","pattern":"^[+-](name|record_created_at|record_updated_at)(,[+-](name|record_created_at|record_updated_at))*$"},"description":"One or more sort fields with direction prefix. Use + for ascending, - for descending. Available fields: name, record_created_at, record_updated_at.\n"}},"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}}}}