class Shopify::Product

• Shopify::Product
• Shopify::Resource
• Reference
• Object

Extended Modules

• Shopify::Resource::ClassMethods

Defined in:

Constructors

• .new(pull : JSON::PullParser)

Class Method Summary

• .all(domain : String, depth : Int32 = 20, headers : HTTP::Headers = headers) : Array(Shopify::Product)

  Used to return an array of products.

• .all(domain : String, next_page_uri : String? = nil, depth : Int32 = 20, headers : HTTP::Headers = headers, &block : self -> )

  Used to iterate over all products.

• .count(domain : String, headers : HTTP::Headers = headers) : Int64

  Used to get a count of all products.

• .create(body : String, domain : String, headers : HTTP::Headers = headers) : Shopify::Product

  Used to create one product.

• .find(id : Int64, domain : String, headers : HTTP::Headers = headers) : Shopify::Product

  Used to fetch one product.

• .uri(domain : String, path : String = "") : URI
• .with(store : Store)

Instance Method Summary

• #body_html : String
• #body_html=(body_html : String)
• #create_product_variant(body : String) : Shopify::ProductVariant
• #created_at : Time
• #created_at=(created_at : Time)
• #delete

  Used to delete one product.

• #handle : String
• #handle=(handle : String)
• #id : Int64
• #id=(id : Int64)
• #images : Array(JSON::Any)
• #images=(images : Array(JSON::Any))
• #options : JSON::Any
• #options=(options : JSON::Any)
• #product_type : String
• #product_type=(product_type : String)
• #published_at : Time?
• #published_at=(published_at : Time?)
• #published_scope : String
• #published_scope=(published_scope : String)
• #status : String
• #status=(status : String)
• #tags : String
• #tags=(tags : String)
• #template_suffix : String?
• #template_suffix=(template_suffix : String?)
• #title : String
• #title=(title : String)
• #update(body : String) : self

  Under the covers, this just runs: plaintext PUT /admin/api/2022-01/products/{id}.json

• #updated_at : Time
• #updated_at=(updated_at : Time)
• #variants : Array(Shopify::ProductVariant)
• #variants=(variants : Array(Shopify::ProductVariant))
• #vendor : String
• #vendor=(vendor : String)

Constructor Detail

Class Method Detail

Shopify::Product.with(store).all #=> Array(Shopify::Product)

Shopify::Product.all(domain, headers: headers) #=> Array(Shopify::Product)

Shopify::Product.with(store).all do |product|
  # do something with product
end

Shopify::Product.all(domain, headers: headers) do |product|
  # do something with product
end

GET
/admin/api/2022-01/products.json

Shopify::Product.with(store).count #=> Int64

Shopify::Product.count(domain, headers: headers) #=> Int64

GET
/admin/api/2022-01/products/count.json

Shopify::Product.with(store).create(body) #=> Shopify::Product

Shopify::Product.create(body, domain, headers: headers) #=> Shopify::Product

POST
/admin/api/2022-01/products.json

Shopify::Product.with(store).find(id) #=> Shopify::Product

Shopify::Product.find(id, domain, headers: headers) #=> Shopify::Product

GET
/admin/api/2022-01/products/{id}.json

Instance Method Detail

DELETE
/admin/api/2022-01/products/{id}.json

PUT
/admin/api/2022-01/products/{id}.json