class ShopifyAPI::Fulfillment
Attributes
Public Class Methods
Source
# File lib/shopify_api/rest/resources/2022_04/fulfillment.rb, line 138 def all( fulfillment_order_id: nil, order_id: nil, created_at_max: nil, created_at_min: nil, fields: nil, limit: nil, since_id: nil, updated_at_max: nil, updated_at_min: nil, session: ShopifyAPI::Context.active_session, **kwargs ) response = base_find( session: session, ids: {fulfillment_order_id: fulfillment_order_id, order_id: order_id}, params: {created_at_max: created_at_max, created_at_min: created_at_min, fields: fields, limit: limit, since_id: since_id, updated_at_max: updated_at_max, updated_at_min: updated_at_min}.merge(kwargs).compact, ) T.cast(response, T::Array[Fulfillment]) end
Source
# File lib/shopify_api/rest/resources/2022_04/fulfillment.rb, line 171 def count( order_id: nil, created_at_min: nil, created_at_max: nil, updated_at_min: nil, updated_at_max: nil, session: ShopifyAPI::Context.active_session, **kwargs ) request( http_method: :get, operation: :count, session: session, ids: {order_id: order_id}, params: {created_at_min: created_at_min, created_at_max: created_at_max, updated_at_min: updated_at_min, updated_at_max: updated_at_max}.merge(kwargs).compact, body: {}, entity: nil, ) end
Source
# File lib/shopify_api/rest/resources/2022_04/fulfillment.rb, line 109 def find( id:, order_id: nil, fields: nil, session: ShopifyAPI::Context.active_session ) result = base_find( session: session, ids: {id: id, order_id: order_id}, params: {fields: fields}, ) T.cast(result[0], T.nilable(Fulfillment)) end
Source
# File lib/shopify_api/rest/resources/2022_04/fulfillment.rb, line 19 def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil) @created_at = T.let(nil, T.nilable(String)) @id = T.let(nil, T.nilable(Integer)) @line_items = T.let(nil, T.nilable(T::Array[T.untyped])) @location_id = T.let(nil, T.nilable(Integer)) @name = T.let(nil, T.nilable(String)) @notify_customer = T.let(nil, T.nilable(T::Boolean)) @order_id = T.let(nil, T.nilable(Integer)) @origin_address = T.let(nil, T.nilable(T::Array[T.untyped])) @receipt = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped])) @service = T.let(nil, T.nilable(String)) @shipment_status = T.let(nil, T.nilable(String)) @status = T.let(nil, T.nilable(String)) @tracking_company = T.let(nil, T.nilable(String)) @tracking_number = T.let(nil, T.nilable(String)) @tracking_numbers = T.let(nil, T.nilable(T::Array[T.untyped])) @tracking_url = T.let(nil, T.nilable(String)) @tracking_urls = T.let(nil, T.nilable(T::Array[T.untyped])) @updated_at = T.let(nil, T.nilable(String)) @variant_inventory_management = T.let(nil, T.nilable(String)) super(session: session, from_hash: from_hash) end
Calls superclass method
ShopifyAPI::Rest::Base::new
Public Instance Methods
Source
# File lib/shopify_api/rest/resources/2022_04/fulfillment.rb, line 199 def cancel( body: nil, **kwargs ) self.class.request( http_method: :post, operation: :cancel, session: @session, ids: {id: @id, order_id: @order_id}, params: {}.merge(kwargs).compact, body: body, entity: self, ) end
Source
# File lib/shopify_api/rest/resources/2022_04/fulfillment.rb, line 220 def complete( body: nil, **kwargs ) self.class.request( http_method: :post, operation: :complete, session: @session, ids: {id: @id, order_id: @order_id}, params: {}.merge(kwargs).compact, body: body, entity: self, ) end
Source
# File lib/shopify_api/rest/resources/2022_04/fulfillment.rb, line 241 def open( body: nil, **kwargs ) self.class.request( http_method: :post, operation: :open, session: @session, ids: {id: @id, order_id: @order_id}, params: {}.merge(kwargs).compact, body: body, entity: self, ) end
Source
# File lib/shopify_api/rest/resources/2022_04/fulfillment.rb, line 264 def update_tracking( notify_customer: nil, tracking_info: nil, body: nil, **kwargs ) self.class.request( http_method: :post, operation: :update_tracking, session: @session, ids: {id: @id}, params: {notify_customer: notify_customer, tracking_info: tracking_info}.merge(kwargs).compact, body: body, entity: self, ) end