class ShopifyAPI::FulfillmentOrder

Attributes

assigned_location[R]
assigned_location_id[R]
created_at[R]
delivery_method[R]
destination[R]
fulfill_at[R]
fulfill_by[R]
fulfillment_holds[R]
id[R]
international_duties[R]
line_items[R]
merchant_requests[R]
order_id[R]
request_status[R]
shop_id[R]
status[R]
supported_actions[R]
updated_at[R]

Public Class Methods

all( order_id: nil, session: ShopifyAPI::Context.active_session, **kwargs ) click to toggle source
# File lib/shopify_api/rest/resources/2022_04/fulfillment_order.rb, line 114
def all(
  order_id: nil,
  session: ShopifyAPI::Context.active_session,
  **kwargs
)
  response = base_find(
    session: session,
    ids: {order_id: order_id},
    params: {}.merge(kwargs).compact,
  )

  T.cast(response, T::Array[FulfillmentOrder])
end
find( id:, session: ShopifyAPI::Context.active_session ) click to toggle source
# File lib/shopify_api/rest/resources/2022_04/fulfillment_order.rb, line 95
def find(
  id:,
  session: ShopifyAPI::Context.active_session
)
  result = base_find(
    session: session,
    ids: {id: id},
    params: {},
  )
  T.cast(result[0], T.nilable(FulfillmentOrder))
end
new(session: ShopifyAPI::Context.active_session, from_hash: nil) click to toggle source
Calls superclass method ShopifyAPI::Rest::Base::new
# File lib/shopify_api/rest/resources/2022_04/fulfillment_order.rb, line 19
def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)

  @assigned_location = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
  @assigned_location_id = T.let(nil, T.nilable(Integer))
  @delivery_method = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
  @destination = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
  @fulfill_at = T.let(nil, T.nilable(String))
  @fulfill_by = T.let(nil, T.nilable(String))
  @fulfillment_holds = T.let(nil, T.nilable(T::Array[T.untyped]))
  @id = T.let(nil, T.nilable(Integer))
  @international_duties = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
  @line_items = T.let(nil, T.nilable(T::Array[T.untyped]))
  @merchant_requests = T.let(nil, T.nilable(T::Array[T.untyped]))
  @order_id = T.let(nil, T.nilable(Integer))
  @request_status = T.let(nil, T.nilable(String))
  @shop_id = T.let(nil, T.nilable(Integer))
  @status = T.let(nil, T.nilable(String))
  @supported_actions = T.let(nil, T.nilable(T::Array[T.untyped]))

  super(session: session, from_hash: from_hash)
end

Public Instance Methods

cancel( body: nil, **kwargs ) click to toggle source
# File lib/shopify_api/rest/resources/2022_04/fulfillment_order.rb, line 136
def cancel(
  body: nil,
  **kwargs
)
  self.class.request(
    http_method: :post,
    operation: :cancel,
    session: @session,
    ids: {id: @id},
    params: {}.merge(kwargs).compact,
    body: body,
    entity: self,
  )
end
close( message: nil, body: nil, **kwargs ) click to toggle source
# File lib/shopify_api/rest/resources/2022_04/fulfillment_order.rb, line 158
def close(
  message: nil,
  body: nil,
  **kwargs
)
  self.class.request(
    http_method: :post,
    operation: :close,
    session: @session,
    ids: {id: @id},
    params: {message: message}.merge(kwargs).compact,
    body: body,
    entity: self,
  )
end
hold( fulfillment_hold: nil, body: nil, **kwargs ) click to toggle source
# File lib/shopify_api/rest/resources/2022_04/fulfillment_order.rb, line 181
def hold(
  fulfillment_hold: nil,
  body: nil,
  **kwargs
)
  self.class.request(
    http_method: :post,
    operation: :hold,
    session: @session,
    ids: {id: @id},
    params: {fulfillment_hold: fulfillment_hold}.merge(kwargs).compact,
    body: body,
    entity: self,
  )
end
move( fulfillment_order: nil, body: nil, **kwargs ) click to toggle source
# File lib/shopify_api/rest/resources/2022_04/fulfillment_order.rb, line 204
def move(
  fulfillment_order: nil,
  body: nil,
  **kwargs
)
  self.class.request(
    http_method: :post,
    operation: :move,
    session: @session,
    ids: {id: @id},
    params: {fulfillment_order: fulfillment_order}.merge(kwargs).compact,
    body: body,
    entity: self,
  )
end
open( body: nil, **kwargs ) click to toggle source
# File lib/shopify_api/rest/resources/2022_04/fulfillment_order.rb, line 226
def open(
  body: nil,
  **kwargs
)
  self.class.request(
    http_method: :post,
    operation: :open,
    session: @session,
    ids: {id: @id},
    params: {}.merge(kwargs).compact,
    body: body,
    entity: self,
  )
end
release_hold( body: nil, **kwargs ) click to toggle source
# File lib/shopify_api/rest/resources/2022_04/fulfillment_order.rb, line 247
def release_hold(
  body: nil,
  **kwargs
)
  self.class.request(
    http_method: :post,
    operation: :release_hold,
    session: @session,
    ids: {id: @id},
    params: {}.merge(kwargs).compact,
    body: body,
    entity: self,
  )
end
reschedule( body: nil, **kwargs ) click to toggle source
# File lib/shopify_api/rest/resources/2022_04/fulfillment_order.rb, line 268
def reschedule(
  body: nil,
  **kwargs
)
  self.class.request(
    http_method: :post,
    operation: :reschedule,
    session: @session,
    ids: {id: @id},
    params: {}.merge(kwargs).compact,
    body: body,
    entity: self,
  )
end
set_fulfillment_orders_deadline( fulfillment_order_ids: nil, fulfillment_deadline: nil, body: nil, **kwargs ) click to toggle source
# File lib/shopify_api/rest/resources/2022_07/fulfillment_order.rb, line 292
def set_fulfillment_orders_deadline(
  fulfillment_order_ids: nil,
  fulfillment_deadline: nil,
  body: nil,
  **kwargs
)
  self.class.request(
    http_method: :post,
    operation: :set_fulfillment_orders_deadline,
    session: @session,
    ids: {},
    params: {fulfillment_order_ids: fulfillment_order_ids, fulfillment_deadline: fulfillment_deadline}.merge(kwargs).compact,
    body: body,
    entity: self,
  )
end