AMambivo
CRM Service Calls

Post Order

Create a new order.

At least one of account_id or contact_id is required.

Request Body (OrderRequest):

  • name (optional): Order name.
  • order_type (default: "sales"): Values: sales, quote.
  • account_id (optional): FK to an account.
  • contact_id (optional): FK to a contact.
  • stage (default: "draft"): Values: draft, pending, approved, fulfilled, cancelled.
  • description (optional): Order notes.
  • total_amount (optional): Total order amount.
  • order_date (optional): Epoch timestamp.
  • order_line_list (optional): Array of line items, e.g. [{"description":"Widget","amount":99.99,"line_detail_dict":{"qty":1,"unit_price":99.99}}].

Response: The created order object.

post/crm/orders

Request

Request body

namestring nullable

Order name

order_typestring nullable

Possible values: sales, quote

account_idstring nullable

FK to Accounts

contact_idstring nullable

FK to AccountContacts

stagestring nullable

Order stage, e.g. draft, pending, approved, fulfilled, cancelled

descriptionstring nullable

Order description / notes

total_amountnumber nullable

Total order amount

order_dateinteger nullable

Order date (epoch timestamp)

Response

Successful Response

idstring required
namestring nullable
stagestring nullable
descriptionstring nullable
order_numstring nullable
order_typestring nullable
order_datestring nullable
total_amountstring nullable
agreement_signed_datestring nullable
created_tsstring nullable
created_ts_datestring nullable
updated_tsstring nullable
updated_ts_datestring nullable
accountstring nullable
primary_sales_agent_emailstring nullable
contactstring nullable
opportunitystring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.