External Orders

Create new sales orders from external source into Smart It

List

Request
Method: GET
URL: https://silink.smart-it.co.za/api/v1/orderexternal
Response
1<externalorders>
2  <externalorder>FCF7ECE399964D35B2904393E6B76425</externalorder>
3  <externalorder>E470300D5BAA41AA90F2998E1464F9C1</externalorder>
4</externalorders>

Retrieve

Request
Method: GET
URL: https://silink.smart-it.co.za/api/v1/orderexternal/E470300D5BAA41AA90F2998E1464F9C1
Response
 1<externalorder>
 2  <customer>
 3    <cellphone_number>083 911 012</cellphone_number>
 4    <customer_code>SAME_EMAIL_B</customer_code>
 5    <customer_name>Monty Python</customer_name>
 6    <delivery_address_1>18 Road</delivery_address_1>
 7    <delivery_address_2>Unit 123</delivery_address_2>
 8    <delivery_address_3>The Grand Archdukery</delivery_address_3>
 9    <delivery_address_city>Pretoria</delivery_address_city>
10    <delivery_address_country>South Africa</delivery_address_country>
11    <delivery_address_postcode>8001</delivery_address_postcode>
12    <delivery_address_province>Gauteng</delivery_address_province>
13    <delivery_address_suburb>Wilgers</delivery_address_suburb>
14    <email>monty@example.com</email>
15  </customer>
16  <customer_orderno>MP128</customer_orderno>
17  <external_reference>APP04</external_reference>
18  <items>
19    <item>
20      <itemcode>322-26J</itemcode>
21      <quantity>5.5</quantity>
22      <unitprice_incl>0</unitprice_incl>
23    </item>
24  </items>
25  <invoiceno>0</invoiceno>
26  <salesorder_state>Active</salesorder_state>
27  <salesorder_status>Processing in progress</salesorder_status>
28  <salesorderno>3</salesorderno>
29  <unique_id>E470300D5BAA41AA90F2998E1464F9C1</unique_id>
30</externalorder>

Create

Immediately after creating a new external order the SI actual document numbers and status will not be available because it has not yet synced with the real database. After a sync has happened and the order has been imported in SI it will be available. Use the Retrieve above.

see model section for more

Request
 1Method: POST
 2URL: https://silink.smart-it.co.za/api/v1/orderexternal
 3
 4<externalorder>
 5  <customer>
 6    <cellphone_number>083 911 012</cellphone_number>
 7    <customer_code>SAME_EMAIL_B</customer_code>
 8    <customer_name>Monty Python</customer_name>
 9    <delivery_address_1>18 Road</delivery_address_1>
10    <delivery_address_2>Unit 123</delivery_address_2>
11    <delivery_address_3>The Grand Archdukery</delivery_address_3>
12    <delivery_address_city>Pretoria</delivery_address_city>
13    <delivery_address_country>South Africa</delivery_address_country>
14    <delivery_address_postcode>8001</delivery_address_postcode>
15    <delivery_address_province>Gauteng</delivery_address_province>
16    <delivery_address_suburb>Wilgers</delivery_address_suburb>
17    <email>same@example.com</email>
18  </customer>
19  <customer_orderno>SAMESAME01</customer_orderno>
20  <external_reference>EXT_SAME_01</external_reference>
21  <items>
22    <item>
23      <itemcode>324-CK9</itemcode>
24      <quantity>7.5</quantity>
25      <unitprice_incl>11.51</unitprice_incl>
26    </item>
27  </items>
28</externalorder>
Response
 1<externalorder>
 2  <unique_id>FCF7ECE399964D35B2904393E6B76425</unique_id>
 3  <customer>
 4    <cellphone_number>083 911 012</cellphone_number>
 5    <customer_code>SAME_EMAIL_B</customer_code>
 6    <customer_name>Monty Python</customer_name>
 7    <delivery_address_1>18 Road</delivery_address_1>
 8    <delivery_address_2>Unit 123</delivery_address_2>
 9    <delivery_address_3>The Grand Archdukery</delivery_address_3>
10    <delivery_address_city>Pretoria</delivery_address_city>
11    <delivery_address_country>South Africa</delivery_address_country>
12    <delivery_address_postcode>8001</delivery_address_postcode>
13    <delivery_address_province>Gauteng</delivery_address_province>
14    <delivery_address_suburb>Wilgers</delivery_address_suburb>
15    <email>same@example.com</email>
16  </customer>
17  <customer_orderno>SAMESAME01</customer_orderno>
18  <external_reference>EXT_SAME_01</external_reference>
19  <items>
20    <item>
21      <itemcode>324-CK9</itemcode>
22      <quantity>7.5</quantity>
23      <unitprice_incl>11.51</unitprice_incl>
24    </item>
25  </items>
26</externalorder>

Model

Data types and description

Model
 1externalorder
 2-------------
 3unique_id = string, unique identification created on POST
 4external_reference = string, external id
 5customer_orderno = string, order reference received from customer eg. their purchase order number
 6invoiceno = integer, SI invoice number
 7salesorder_state = string, one of 'Active','Completed','Cancelled'
 8salesorder_status = string, SI sales order status - can be anything
 9salesorderno = integer, SI sales order number for the sales order that was created for this external order
10
11externalorder.customer
12----------------------
13email = string, required, used to lookup customer otherwise customer will be created with the information below
14customer_code = string, optional - if present is used before email to find customer
15customer_name = string
16cellphone_number = string
17delivery_address_1 = string
18delivery_address_2 = string
19delivery_address_3 = string
20delivery_address_suburb = string
21delivery_address_city = string
22delivery_address_province = string
23delivery_address_country = string
24delivery_address_postcode = string
25
26externalorder.items
27----------------------
28itemcode = string, required
29quantity = decimal, required
30unitprice_inc = decimal, optional specify 0 to use the default price