Create a material order

Creates a material order on a job, with its line items in the same request. Wrap the fields in a material_order object and pass items as material_order_items_attributes.

  • Each item needs a product_name, a quantity greater than zero and a unit_cost. unit is the unit of measure (for example bundle or square). Pass product_id to link an item to a product in your catalog.
  • supplier_branch_id picks the distributor branch, and the order's supplier is set to match that branch. An unknown branch ID returns 404. delivery_method is delivery or will_call.
  • order_number is assigned automatically, status defaults to pending, and total_cost is calculated from the items.
  • Creating an order can tick off a matching item on the job's stage checklist. If the company has connected QuickBooks, the order is pushed there as a bill once it reaches a status the company's QuickBooks settings sync.
  • The token's role must have the Work sales leads or Work production jobs permission, and the token needs the write scope.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
material_order
object
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json