Edit Sales Order

Overview
Updating sales order info in MobiWork

URL Format
https://{domain}.mobiwork.com/api/rest/{clientId}/{versionNumber}/salesOrderId/{salesorderId}/edit.html?token=XXXXXXXX&userId={userId}

Arguments

clientId required	MobiWork assigned unique ID of the company
versionNumber required	Version number of MobiWork API SDK release. Current version is: 10.0.78
token required	Part of URL as a request parameter and is required in every call to verify access to API calls
userId optional	If provided, this User ID will be taken as a logged in user. If not provided we use an active global administrator ID
salesorderId required	The identifier of the sales order to be retrieved

Return
Returns a sale sorder Object if sales order update is successful or errors will be returned

Request Body XSD

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
  <xs:element name="request">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="salesOrder"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="salesOrder">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="mobiworkSalesOrderId"/>
        <xs:element ref="customerId"/>
        <xs:element ref="customerName"/>
        <xs:element ref="createdDate"/>
        <xs:element ref="createdById"/>
        <xs:element ref="createdByName"/>
        <xs:element ref="externalId"/>
        <xs:element ref="status"/>
        <xs:element ref="comments"/>
        <xs:element ref="salesOrderType"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="mobiworkSalesOrderId" type="xs:integer"/>
  <xs:element name="customerId" type="xs:integer"/>
  <xs:element name="customerName" type="xs:string"/>
  <xs:element name="createdDate" type="xs:string"/>
  <xs:element name="createdById" type="xs:integer"/>
  <xs:element name="createdByName" type="xs:string"/>
  <xs:element name="externalId" type="xs:NCName"/>
  <xs:element name="status" type="xs:NCName"/>
  <xs:element name="comments" type="xs:string"/>
  <xs:element name="salesOrderType" type="xs:NCName"/>
</xs:schema>

Response Body XSD

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
  <xs:element name="response">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="salesOrder"/>
      </xs:sequence>
      <xs:attribute name="statusCode" use="required" type="xs:integer"/>
      <xs:attribute name="version" use="required" type="xs:NMTOKEN"/>
    </xs:complexType>
  </xs:element>
  <xs:element name="salesOrder">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="mobiworkSalesOrderId"/>
        <xs:element ref="customerId"/>
        <xs:element ref="customerName"/>
        <xs:element ref="createdDate"/>
        <xs:element ref="createdById"/>
        <xs:element ref="createdByName"/>
        <xs:element ref="externalId"/>
        <xs:element ref="status"/>
        <xs:element ref="comments"/>
        <xs:element ref="salesOrderType"/>
        <xs:element ref="deliveryAddress"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="mobiworkSalesOrderId" type="xs:integer"/>
  <xs:element name="customerId" type="xs:integer"/>
  <xs:element name="customerName" type="xs:string"/>
  <xs:element name="createdDate" type="xs:string"/>
  <xs:element name="createdById" type="xs:integer"/>
  <xs:element name="createdByName" type="xs:string"/>
  <xs:element name="externalId" type="xs:NCName"/>
  <xs:element name="status" type="xs:NCName"/>
  <xs:element name="comments">
    <xs:complexType/>
  </xs:element>
  <xs:element name="salesOrderType" type="xs:NCName"/>
  <xs:element name="deliveryAddress">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="addressId"/>
        <xs:element ref="address1"/>
        <xs:element ref="address2"/>
        <xs:element ref="city"/>
        <xs:element ref="state"/>
        <xs:element ref="zipCode"/>
        <xs:element ref="countryId"/>
        <xs:element ref="latitude"/>
        <xs:element ref="longitude"/>
        <xs:element ref="name"/>
        <xs:element ref="baseDistance"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="addressId" type="xs:integer"/>
  <xs:element name="address1" type="xs:string"/>
  <xs:element name="address2" type="xs:string"/>
  <xs:element name="city" type="xs:string"/>
  <xs:element name="state" type="xs:NCName"/>
  <xs:element name="zipCode">
    <xs:complexType/>
  </xs:element>
  <xs:element name="countryId" type="xs:integer"/>
  <xs:element name="latitude" type="xs:decimal"/>
  <xs:element name="longitude" type="xs:decimal"/>
  <xs:element name="name">
    <xs:complexType/>
  </xs:element>
  <xs:element name="baseDistance" type="xs:integer"/>
</xs:schema>

Curl Example

HTTP Method:	POST
Request:	curl -k -X POST "https://www.mobiwork.com/api/rest/12026/5.0.141/salesorder/12345/edit.html?token=COJL8X2FKSLMMRTYCH2B" -data ' <request> <salesOrder> <mobiworkSalesOrderId>123</mobiworkSalesOrderId> <customerId>123</customerId> <customerName>John Doe</customerName> <createdDate>2018/06/04</createdDate> <createdById>123</createdById> <createdByName>Jane Doe</createdByName> <externalId>null</externalId> <status>OPEN_SHOPPING_CART</status> <comments>null</comments> <salesOrderType>SALES_ORDER_ONLINE_CATALOG </salesOrderType> </salesOrder> </request>
Response:	<response version="5.0.141" statusCode="1"> <salesOrder> <mobiworkSalesOrderId>123</mobiworkSalesOrderId> <customerId>123</customerId> <customerName>John Doe</customerName> <createdDate>2018/06/04</createdDate> <createdById>123</createdById> <createdByName>Jane Doe</createdByName> <externalId>null</externalId> <status>OPEN_SHOPPING_CART</status> <comments>null</comments> <salesOrderType>SALES_ORDER_ONLINE_CATALOG </salesOrderType> </salesOrder> </response>