PRODUCT_ORDER_MANAGE PRODUCT Endpoint
  /rpc/product/?method=PRODUCT_ORDER_MANAGE  
  Object: 43. Click here for more information.  
  PARAMETERS TYPE  
  DataReturn Text A comma delimited list of advanced search fields to be returned after a successful save
  Id Numeric  
  Remove Numeric Pass '1' to remove the item
       
  Action Numeric See below
  Area Numeric You can use an area that you have defined, or pass -1 to set the Area based on the product, or -2 to be based on the Contact
  BillToBusiness Numeric Contact Business to bill. Leave blank if you want to bill the orderbybusiness
  BillToPerson Numeric Contact Person to bill. Leave blank if you want to bill the orderbybusiness
  CardExpiry Date Format expected is MMM YY, or MMM YYYY
  CardHoldersName Text (50)  
  CardNumber Text (50)  
  DefaultAddress Text (1) Y/N. Set this to Y and it will pick up the address in the following order:
  • If the Order has a orderbybusiness, and that orderbybusiness has a BillToBusiness, then it will choose the Bill To Business's Address for the BILLING / MAILING ADDRESS and the orderbybusiness street address for the Delivery Address.
  • the orderbybusiness, or if that is blank,
  • then the orderbyperson.

If you set this to Y, it will also overr-ride the billtobusiness and billtoperson, based on the OrderByBusiness
  DeliveryDate Date  
  DeliveryDateTimeZone Numeric  
  DeliveryNotes Text (1000)  
  KeyDate Date  
  KeyDateTimeZone Numeric  
  MailingAddress1 Text (100)  
  MailingAddress2 Text (100)  
  MailingCountry Text (50)  
  MailingPostCode Text (10)  
  MailingState Text (30)  
  MailingSuburb Text (50)  
  Notes Text (2000)  
  Object Numeric  
  ObjectContext Numeric  
  OrderByBusiness Numeric Mandatory (must pass OrderByBusiness and / or OrderByPerson). Contact Business that the order is for
  OrderByPerson Numeric Mandatory (must pass OrderByBusiness and / or OrderByPerson). Contact Person that the order is for
  OrderDate Date  
  OrderDateTimeZone Numeric  
  ProcessingStatus Numeric You can define your own. Works in conjunction with status
  Project Numeric Project that the order is for. If not specified, it will default to your default financials project
  PurchaseOrder Text (20) Used for the orderbyperson's reference
  Reference Text (50) If left blank, will default to ORDnnnnnn. The next value is held the business profile #62. See CORE_PROFILE_MANAGE. If profile setting 371 is set to Y, then the reference must be unique
  ReferenceMask Text (50) Alternatively, you can pass a mask to generate the Reference. It should have question mark(s) where the number is meant to go. For example with the next number of 123, "REF_??????" would generate "REF_000123". "REF?" would generate "REF123", "REF??????abc" would generate "REF000123abc". Note: The reference has to be blank for this to take effect
  Salesperson Numeric Contact Person of the sales person
  Source Numeric 1=Regular Order / Manual Order,2=Website / Shop Order. Or you can define your own, see SETUP_PRODUCT_ORDER_SOURCE_MANAGE
  Status Numeric 1=Completed,2=To Be Processed,4=Not Started,5=Awaiting Final Submit (Web Order),6=Requires Approval,7=Processing,8=Cancelled,9=On Hold,10=On Back Order / Part Delivered,11=Invoiced - In Progress
  StreetAddress1 Text (100)  
  StreetAddress2 Text (100)  
  StreetCountry Text (50)  
  StreetPostCode Text (10)  
  StreetState Text (30)  
  StreetSuburb Text (50)  
  STATUS / ACTION  
    When progressing an order you have two options. You can manually update the status, or you can use actions. Updating the status could be used for administration / override forms, or where you want to have full control over deliveries, invoicing etc. It simply updates the status of the order. Actions, however, trigger additional server processing, as documented below, as well as updating the status. Actions have validation.
  action
  • 1=Save Order. Redundant for most implementations
  • 2=Submit Order. This checks the credit limit of the customer (needs credit limit to have been set on the orderbybusiness). If credit limit exceeded, the order will end up with a status of 6 (Requires Approval). Otherwise, will be set to 7 (Processing).
  • 3=Approve. If the status is 6 (Requires Approval), the status is set to 7 (Processing).  Otherwise the status is set to 2 (To Be processed)
  • 4=Cancel. Cancels any linked Supplier Orders
  • 5=Place On Hold. Currently just changes status
  • 6=Place On Back Order. Currently just changes status
  • 7=Unsubmit. Currently just changes status
  • 8=Finalise. As a note, only use this action if you do not want control over deliveries. It creates a Delivery record, checks commissions, and creates an invoice.
  status 1=Completed,2=To Be Processed,4=Not Started,5=Awaiting Final Submit (Web Order),6=Requires Approval,7=Processing,8=Cancelled,9=On Hold,10=On Back Order / Part Delivered,11=Invoiced - In Progress
  RETURN  
  id  
  EXAMPLE