Skip to content

Commit 15348df

Browse files
jgarlickjgarlick
authored
Merge pull request #12 from jgarlick/dispatches_additions
Update apidocs to match additions to dispatches
2 parents 765d945 + 28e6734 commit 15348df

File tree

2 files changed

+138
-0
lines changed

2 files changed

+138
-0
lines changed

‎source/includes/models/_dispatches.html.md‎

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,21 @@ Dispatches represent items being fulfilled
1414
"order_number": 1289,
1515
"created": "2021-04-16T12:58:39Z",
1616
"comments": "Sent by Royal Mail using Next Day Delivery",
17+
"customer_note": "",
18+
"customer_po_number": "",
19+
"shipping_type": "Next Day Delivery",
20+
"shipping_address": {
21+
"company_name": "Sample Customer",
22+
"contact_name": "",
23+
"line1": "34 Edgar Buildings",
24+
"line2": "George Street",
25+
"city": "Bath",
26+
"state": "",
27+
"postal_code": "BA1 2FJ",
28+
"country": "GB"
29+
},
30+
"email_address": "[email protected]",
31+
"phone": "07911 123456",
1732
"dispatch_lines": [
1833
{
1934
"order_line_id": "ol_z1ow2pdm",
@@ -50,6 +65,69 @@ Dispatches represent items being fulfilled
5065
<h3><span class="name">comments</span> <span class="type">string</span></h3>
5166
<div class="description">Comments to be shown on the delivery note and the dispatch email sent to the customer. This can contain courier details and tracking info, and anything else that the customer needs to know</div>
5267
</li>
68+
<li>
69+
<h3><span class="name">customer_po_number</span> <span class="type">string</span></h3>
70+
<div class="description">The customer's purchase order number for the related order</div>
71+
</li>
72+
<li>
73+
<h3><span class="name">customer_note</span> <span class="type">string</span></h3>
74+
<div class="description">The customer's note on the related order</div>
75+
</li>
76+
<li>
77+
<h3><span class="name">shipping_type</span> <span class="type">string</span></h3>
78+
<div class="description">The name of the shipping option selected for the related order</div>
79+
</li>
80+
<li>
81+
<h3><span class="name">shipping_address</span> <span class="type ha">hash</span></h3>
82+
<div class="description">
83+
The shipping address for the related order
84+
<div class="child-attributes">
85+
<h4>Child Attributes</h4>
86+
<ul>
87+
<li>
88+
<h3><span class="parent-name">shipping_address.</span><span class="name">company_name</span> <span class="type">string</span></h3>
89+
<div class="description">Company name</div>
90+
</li>
91+
<li>
92+
<h3><span class="parent-name">shipping_address.</span><span class="name">contact_name</span> <span class="type">string</span></h3>
93+
<div class="description">Contact name</div>
94+
</li>
95+
<li>
96+
<h3><span class="parent-name">shipping_address.</span><span class="name">line1</span> <span class="type">string</span></h3>
97+
<div class="description">Address line 1</div>
98+
</li>
99+
<li>
100+
<h3><span class="parent-name">shipping_address.</span><span class="name">line2</span> <span class="type">string</span></h3>
101+
<div class="description">Address line 2</div>
102+
</li>
103+
<li>
104+
<h3><span class="parent-name">shipping_address.</span><span class="name">city</span> <span class="type">string</span></h3>
105+
<div class="description">City, town or village</div>
106+
</li>
107+
<li>
108+
<h3><span class="parent-name">shipping_address.</span><span class="name">state</span> <span class="type">string</span></h3>
109+
<div class="description">State, county, province or region. U.S., Canadian and Australian addresses should use the abbreviated form of the state</div>
110+
</li>
111+
<li>
112+
<h3><span class="parent-name">shipping_address.</span><span class="name">postal_code</span> <span class="type">string</span></h3>
113+
<div class="description">ZIP or postal code</div>
114+
</li>
115+
<li>
116+
<h3><span class="parent-name">shipping_address.</span><span class="name">country</span> <span class="type">string</span></h3>
117+
<div class="description">Two-letter ISO 3166-1 country code</div>
118+
</li>
119+
</ul>
120+
</div>
121+
</div>
122+
</li>
123+
<li>
124+
<h3><span class="name">email_address</span> <span class="type">string</span></h3>
125+
<div class="description">The customer's email address for the related order</div>
126+
</li>
127+
<li>
128+
<h3><span class="name">phone</span> <span class="type">string</span></h3>
129+
<div class="description">The customer's phone number for the related order</div>
130+
</li>
53131
<li>
54132
<h3><span class="name">dispatch_lines</span> <span class="type li">list</span></h3>
55133
<div class="description">
@@ -114,6 +192,21 @@ curl -X POST "https://api.orderspace.com/v1/dispatches" \
114192
"order_number": 1289,
115193
"created": "2021-04-16T12:58:39Z",
116194
"comments": "Sent by Royal Mail using Next Day Delivery",
195+
"customer_note": "",
196+
"customer_po_number": "",
197+
"shipping_type": "Next Day Delivery",
198+
"shipping_address": {
199+
"company_name": "Sample Customer",
200+
"contact_name": "",
201+
"line1": "34 Edgar Buildings",
202+
"line2": "George Street",
203+
"city": "Bath",
204+
"state": "",
205+
"postal_code": "BA1 2FJ",
206+
"country": "GB"
207+
},
208+
"email_address": "[email protected]",
209+
"phone": "07911 123456",
117210
"dispatch_lines": [
118211
{
119212
"order_line_id": "ol_z1ow2pdm",
@@ -183,6 +276,21 @@ curl -X GET https://api.orderspace.com/v1/dispatches \
183276
"order_number": 1289,
184277
"created": "2021-04-16T12:58:39Z",
185278
"comments": "Sent by Royal Mail using Next Day Delivery",
279+
"customer_note": "",
280+
"customer_po_number": "",
281+
"shipping_type": "Next Day Delivery",
282+
"shipping_address": {
283+
"company_name": "Sample Customer",
284+
"contact_name": "",
285+
"line1": "34 Edgar Buildings",
286+
"line2": "George Street",
287+
"city": "Bath",
288+
"state": "",
289+
"postal_code": "BA1 2FJ",
290+
"country": "GB"
291+
},
292+
"email_address": "[email protected]",
293+
"phone": "07911 123456",
186294
"dispatch_lines": [
187295
{
188296
"order_line_id": "ol_z1ow2pdm",
@@ -261,6 +369,21 @@ curl -X GET https://api.orderspace.com/v1/dispaches/di_4kzzxdk2 \
261369
"order_number": 1289,
262370
"created": "2021-04-16T12:58:39Z",
263371
"comments": "Sent by Royal Mail using Next Day Delivery",
372+
"customer_note": "",
373+
"customer_po_number": "",
374+
"shipping_type": "Next Day Delivery",
375+
"shipping_address": {
376+
"company_name": "Sample Customer",
377+
"contact_name": "",
378+
"line1": "34 Edgar Buildings",
379+
"line2": "George Street",
380+
"city": "Bath",
381+
"state": "",
382+
"postal_code": "BA1 2FJ",
383+
"country": "GB"
384+
},
385+
"email_address": "[email protected]",
386+
"phone": "07911 123456",
264387
"dispatch_lines": [
265388
{
266389
"order_line_id": "ol_z1ow2pdm",

‎source/includes/models/_webhook_events.html.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -188,6 +188,21 @@ Triggered when a customer is updated.
188188
"order_number": 1289,
189189
"created": "2021-04-16T12:58:39Z",
190190
"comments": "Sent by Royal Mail using Next Day Delivery",
191+
"customer_note": "",
192+
"customer_po_number": "",
193+
"shipping_type": "Next Day Delivery",
194+
"shipping_address": {
195+
"company_name": "Blue Sky",
196+
"contact_name": "Emilia Jane Dogherty",
197+
"line1": "12 Blue Sky Lane",
198+
"line2": "",
199+
"city": "Bristol",
200+
"state": "",
201+
"postal_code": "BS1 2DF",
202+
"country": "GB"
203+
},
204+
"email_address": "[email protected]",
205+
"phone": "12345",
191206
"dispatch_lines": [
192207
{
193208
"order_line_id": "ol_z1ow2pdm",

0 commit comments

Comments
 (0)