Class: Spree::Api::V3::Admin::OrdersController
- Inherits:
-
ResourceController
- Object
- ActionController::API
- BaseController
- ResourceController
- Spree::Api::V3::Admin::OrdersController
- Includes:
- OrderLock
- Defined in:
- app/controllers/spree/api/v3/admin/orders_controller.rb
Constant Summary
Constants inherited from BaseController
BaseController::RATE_LIMIT_RESPONSE
Constants included from Idempotent
Idempotent::IDEMPOTENCY_HEADER, Idempotent::IDEMPOTENCY_TTL, Idempotent::MAX_KEY_LENGTH, Idempotent::MUTATING_METHODS
Constants included from ErrorHandler
Constants included from JwtAuthentication
JwtAuthentication::JWT_AUDIENCE_ADMIN, JwtAuthentication::JWT_AUDIENCE_STORE, JwtAuthentication::JWT_ISSUER, JwtAuthentication::USER_TYPE_ADMIN, JwtAuthentication::USER_TYPE_CUSTOMER
Instance Method Summary collapse
-
#approve ⇒ Object
PATCH /api/v3/admin/orders/:id/approve.
-
#cancel ⇒ Object
PATCH /api/v3/admin/orders/:id/cancel.
-
#complete ⇒ Object
PATCH /api/v3/admin/orders/:id/complete.
-
#create ⇒ Object
POST /api/v3/admin/orders.
-
#resend_confirmation ⇒ Object
POST /api/v3/admin/orders/:id/resend_confirmation.
-
#resume ⇒ Object
PATCH /api/v3/admin/orders/:id/resume.
-
#update ⇒ Object
PATCH /api/v3/admin/orders/:id.
Methods inherited from ResourceController
Methods included from Spree::Api::V3::ApiKeyAuthentication
#authenticate_api_key!, #authenticate_secret_key!
Methods included from JwtAuthentication
#authenticate_user, #require_authentication!
Instance Method Details
#approve ⇒ Object
PATCH /api/v3/admin/orders/:id/approve
73 74 75 76 77 78 |
# File 'app/controllers/spree/api/v3/admin/orders_controller.rb', line 73 def approve with_order_lock do @resource.approved_by(try_spree_current_user) render json: serialize_resource(@resource.reload) end end |
#cancel ⇒ Object
PATCH /api/v3/admin/orders/:id/cancel
65 66 67 68 69 70 |
# File 'app/controllers/spree/api/v3/admin/orders_controller.rb', line 65 def cancel with_order_lock do @resource.canceled_by(try_spree_current_user) render json: serialize_resource(@resource.reload) end end |
#complete ⇒ Object
PATCH /api/v3/admin/orders/:id/complete
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 |
# File 'app/controllers/spree/api/v3/admin/orders_controller.rb', line 48 def complete with_order_lock do result = Spree.order_complete_service.call( order: @resource, payment_pending: ActiveModel::Type::Boolean.new.cast(params[:payment_pending]), notify_customer: ActiveModel::Type::Boolean.new.cast(params[:notify_customer]) ) if result.success? render json: serialize_resource(@resource.reload) else render_service_error(@resource.errors.presence || result.error, code: ERROR_CODES[:order_cannot_complete]) end end end |
#create ⇒ Object
POST /api/v3/admin/orders
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 |
# File 'app/controllers/spree/api/v3/admin/orders_controller.rb', line 14 def create (:create, Spree::Order) result = Spree.order_create_service.call( store: current_store, user: resolve_user, params: order_create_params ) if result.success? @resource = result.value render json: serialize_resource(@resource), status: :created else render_service_error(result.error) end end |
#resend_confirmation ⇒ Object
POST /api/v3/admin/orders/:id/resend_confirmation
89 90 91 92 |
# File 'app/controllers/spree/api/v3/admin/orders_controller.rb', line 89 def resend_confirmation @resource.publish_event('order.completed') render json: serialize_resource(@resource) end |
#resume ⇒ Object
PATCH /api/v3/admin/orders/:id/resume
81 82 83 84 85 86 |
# File 'app/controllers/spree/api/v3/admin/orders_controller.rb', line 81 def resume with_order_lock do @resource.resume! render json: serialize_resource(@resource.reload) end end |
#update ⇒ Object
PATCH /api/v3/admin/orders/:id
32 33 34 35 36 37 38 39 40 41 42 43 44 45 |
# File 'app/controllers/spree/api/v3/admin/orders_controller.rb', line 32 def update with_order_lock do result = Spree.order_update_service.call( order: @resource, params: order_update_params ) if result.success? render json: serialize_resource(result.value) else render_validation_error(@resource.errors.presence || result.error) end end end |