Skip to content

Latest commit

 

History

History
392 lines (255 loc) · 8.35 KB

ProductsItemApi.md

File metadata and controls

392 lines (255 loc) · 8.35 KB

Connectwise::ProductsItemApi

All URIs are relative to https://api-na.myconnectwise.net/v4_6_release/apis/3.0

Method HTTP request Description
procurement_products_count_get GET /procurement/products/count
procurement_products_get GET /procurement/products
procurement_products_id_delete DELETE /procurement/products/{id}
procurement_products_id_get GET /procurement/products/{id}
procurement_products_id_patch PATCH /procurement/products/{id}
procurement_products_id_put PUT /procurement/products/{id}
procurement_products_post POST /procurement/products

procurement_products_count_get

Count procurement_products_count_get(opts)

Get Products Count

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
Connectwise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Connectwise::ProductsItemApi.new

opts = { 
  conditions: "conditions_example" # String | 
}

begin
  result = api_instance.procurement_products_count_get(opts)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling ProductsItemApi->procurement_products_count_get: #{e}"
end

Parameters

Name Type Description Notes
conditions String [optional]

Return type

Count

Authorization

BasicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

procurement_products_get

Array<ProductItem> procurement_products_get(opts)

Get Products

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
Connectwise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Connectwise::ProductsItemApi.new

opts = { 
  conditions: "conditions_example" # String | 
  order_by: "order_by_example", # String | 
  page: 56, # Integer | 
  page_size: 56 # Integer | 
}

begin
  result = api_instance.procurement_products_get(opts)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling ProductsItemApi->procurement_products_get: #{e}"
end

Parameters

Name Type Description Notes
conditions String [optional]
order_by String [optional]
page Integer [optional]
page_size Integer [optional]

Return type

Array<ProductItem>

Authorization

BasicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

procurement_products_id_delete

procurement_products_id_delete(id)

Delete Product By Id

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
Connectwise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Connectwise::ProductsItemApi.new

id = 56 # Integer | 


begin
  api_instance.procurement_products_id_delete(id)
rescue Connectwise::ApiError => e
  puts "Exception when calling ProductsItemApi->procurement_products_id_delete: #{e}"
end

Parameters

Name Type Description Notes
id Integer

Return type

nil (empty response body)

Authorization

BasicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

procurement_products_id_get

ProductItem procurement_products_id_get(id)

Get Product By Id

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
Connectwise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Connectwise::ProductsItemApi.new

id = 56 # Integer | 


begin
  result = api_instance.procurement_products_id_get(id)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling ProductsItemApi->procurement_products_id_get: #{e}"
end

Parameters

Name Type Description Notes
id Integer

Return type

ProductItem

Authorization

BasicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

procurement_products_id_patch

ProductItem procurement_products_id_patch(id, operations)

Update Product

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
Connectwise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Connectwise::ProductsItemApi.new

id = 56 # Integer | 

operations = [Connectwise::PatchOperation.new] # Array<PatchOperation> | 


begin
  result = api_instance.procurement_products_id_patch(id, operations)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling ProductsItemApi->procurement_products_id_patch: #{e}"
end

Parameters

Name Type Description Notes
id Integer
operations Array<PatchOperation>

Return type

ProductItem

Authorization

BasicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

procurement_products_id_put

ProductItem procurement_products_id_put(id, product_item)

Replace Product

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
Connectwise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Connectwise::ProductsItemApi.new

id = 56 # Integer | 

product_item = Connectwise::ProductItem.new # ProductItem | 


begin
  result = api_instance.procurement_products_id_put(id, product_item)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling ProductsItemApi->procurement_products_id_put: #{e}"
end

Parameters

Name Type Description Notes
id Integer
product_item ProductItem

Return type

ProductItem

Authorization

BasicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

procurement_products_post

ProductItem procurement_products_post(product_item)

Create Product

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
Connectwise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Connectwise::ProductsItemApi.new

product_item = Connectwise::ProductItem.new # ProductItem | 


begin
  result = api_instance.procurement_products_post(product_item)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling ProductsItemApi->procurement_products_post: #{e}"
end

Parameters

Name Type Description Notes
product_item ProductItem

Return type

ProductItem

Authorization

BasicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json