Class: Brightpearl::OrderCustomField

Inherits:
Resource
  • Object
show all
Defined in:
lib/brightpearl/resources/order_custom_field.rb

Overview

Order custom fields are user-defined data held against an order. Custom fields are defined separately for sales and purchase orders. Field names and data types are shared between every order of the same type. Several data types are available.

Class Method Summary collapse

Methods inherited from Resource

send_request, to_query

Class Method Details

.get(order_id) ⇒ Object

api-docs.brightpearl.com/order/order-customfields/get.html



8
9
10
 
# File 'lib/brightpearl/resources/order_custom_field.rb', line 8

def get(order_id)
  send_request(path: "order-service/order/#{order_id}/custom-field", method: :get)
end

.patch(order_id, params) ⇒ Object

api-docs.brightpearl.com/order/order-customfields/patch.html



13
14
15
 
# File 'lib/brightpearl/resources/order_custom_field.rb', line 13

def patch(order_id, params)
  send_request(path: "order-service/order/#{order_id}/custom-field", method: :patch, body: params)
end