Skip to content

Latest commit

 

History

History
243 lines (177 loc) · 7.66 KB

ProductsApi.md

File metadata and controls

243 lines (177 loc) · 7.66 KB
Raw

Conekta::ProductsApi

All URIs are relative to https://api.conekta.io

Method HTTP request Description
orders_create_product POST /orders/{id}/line_items Create Product
orders_delete_product DELETE /orders/{id}/line_items/{line_item_id} Delete Product
orders_update_product PUT /orders/{id}/line_items/{line_item_id} Update Product

orders_create_product

orders_create_product(id, product, opts)

Create Product

Create a new product for an existing order.

Examples

require 'time'
require 'conekta'
# setup authorization
Conekta.configure do |config|
  # Configure Bearer authorization: bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = Conekta::ProductsApi.new
id = '6307a60c41de27127515a575' # String | Identifier of the resource
product = Conekta::Product.new({name: 'Box of Cohiba S1s', quantity: 1, unit_price: 20000}) # Product | requested field for a product
opts = {
  accept_language: 'es', # String | Use for knowing which language to use
  x_child_company_id: '6441b6376b60c3a638da80af' # String | In the case of a holding company, the company id of the child company to which will process the request.
}

begin
  # Create Product
  result = api_instance.orders_create_product(id, product, opts)
  p result
rescue Conekta::ApiError => e
  puts "Error when calling ProductsApi->orders_create_product: #{e}"
end

Using the orders_create_product_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> orders_create_product_with_http_info(id, product, opts)

begin
  # Create Product
  data, status_code, headers = api_instance.orders_create_product_with_http_info(id, product, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ProductOrderResponse>
rescue Conekta::ApiError => e
  puts "Error when calling ProductsApi->orders_create_product_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
id String Identifier of the resource
product Product requested field for a product
accept_language String Use for knowing which language to use [optional][default to 'es']
x_child_company_id String In the case of a holding company, the company id of the child company to which will process the request. [optional]

Return type

ProductOrderResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/vnd.conekta-v2.1.0+json

orders_delete_product

orders_delete_product(id, line_item_id, opts)

Delete Product

Delete product for an existing orden

Examples

require 'time'
require 'conekta'
# setup authorization
Conekta.configure do |config|
  # Configure Bearer authorization: bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = Conekta::ProductsApi.new
id = '6307a60c41de27127515a575' # String | Identifier of the resource
line_item_id = 'line_item_2tQ8HkkfbauaKP9Ho' # String | identifier
opts = {
  accept_language: 'es', # String | Use for knowing which language to use
  x_child_company_id: '6441b6376b60c3a638da80af' # String | In the case of a holding company, the company id of the child company to which will process the request.
}

begin
  # Delete Product
  result = api_instance.orders_delete_product(id, line_item_id, opts)
  p result
rescue Conekta::ApiError => e
  puts "Error when calling ProductsApi->orders_delete_product: #{e}"
end

Using the orders_delete_product_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> orders_delete_product_with_http_info(id, line_item_id, opts)

begin
  # Delete Product
  data, status_code, headers = api_instance.orders_delete_product_with_http_info(id, line_item_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ProductOrderResponse>
rescue Conekta::ApiError => e
  puts "Error when calling ProductsApi->orders_delete_product_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
id String Identifier of the resource
line_item_id String identifier
accept_language String Use for knowing which language to use [optional][default to 'es']
x_child_company_id String In the case of a holding company, the company id of the child company to which will process the request. [optional]

Return type

ProductOrderResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/vnd.conekta-v2.1.0+json

orders_update_product

orders_update_product(id, line_item_id, update_product, opts)

Update Product

Update an existing product for an existing orden

Examples

require 'time'
require 'conekta'
# setup authorization
Conekta.configure do |config|
  # Configure Bearer authorization: bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = Conekta::ProductsApi.new
id = '6307a60c41de27127515a575' # String | Identifier of the resource
line_item_id = 'line_item_2tQ8HkkfbauaKP9Ho' # String | identifier
update_product = Conekta::UpdateProduct.new # UpdateProduct | requested field for products
opts = {
  accept_language: 'es', # String | Use for knowing which language to use
  x_child_company_id: '6441b6376b60c3a638da80af' # String | In the case of a holding company, the company id of the child company to which will process the request.
}

begin
  # Update Product
  result = api_instance.orders_update_product(id, line_item_id, update_product, opts)
  p result
rescue Conekta::ApiError => e
  puts "Error when calling ProductsApi->orders_update_product: #{e}"
end

Using the orders_update_product_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> orders_update_product_with_http_info(id, line_item_id, update_product, opts)

begin
  # Update Product
  data, status_code, headers = api_instance.orders_update_product_with_http_info(id, line_item_id, update_product, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ProductOrderResponse>
rescue Conekta::ApiError => e
  puts "Error when calling ProductsApi->orders_update_product_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
id String Identifier of the resource
line_item_id String identifier
update_product UpdateProduct requested field for products
accept_language String Use for knowing which language to use [optional][default to 'es']
x_child_company_id String In the case of a holding company, the company id of the child company to which will process the request. [optional]

Return type

ProductOrderResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/vnd.conekta-v2.1.0+json