Skip to content

Commit a89851d

Browse files
committed
Clarify that many fields on the dispatch object are read only
1 parent 15348df commit a89851d

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

source/includes/models/_dispatches.html.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Dispatches
22

3-
Dispatches represent items being fulfilled
3+
A dispatch represents items on an order being fulfilled
44

55
## The Dispatch Object
66

@@ -242,7 +242,9 @@ curl -X POST "https://api.orderspace.com/v1/dispatches" \
242242
}
243243
```
244244

245-
Create a dispatch. This will mark the order lines as dispatched and reduce the stock on hand representing the items leaving your warehouse. The status of the related order will change to <code>fulfilled</code> if all items on the order have been dispatched. A dispatch confirmation email will be sent to the customer if this setting is enabled
245+
Create a dispatch. This will mark the order lines as dispatched and reduce the stock on hand representing the items leaving your warehouse. The status of the related order will change to <code>fulfilled</code> if all items on the order have been dispatched. A dispatch confirmation email will be sent to the customer if this setting is enabled.
246+
247+
Many of the fields on the dispatch object are read only and can not be set when a dispatch is created. See the example for the fields that can be set. All other fields come from the order and are for reference only.
246248

247249
### HTTP Request
248250

0 commit comments

Comments
 (0)