Order PATCH
URI
https://{DATACENTER}.brightpearlconnect.com/public-api/{ACCOUNT}
/order-service/order/{ID}
Refer to our documentation on URI syntax for more information on how to construct URIs.
Description
This message enables you to change the shipping method, warehouse location and reference of an existing order.
- The order must not be invoiced
- At least one of the fields must be changed
Field | Description | Path | Allowed Operations | Required |
---|---|---|---|---|
reference | The customer/supplier reference field allows strings up to 64 characters. If removed, will be set to an empty string. | /reference |
|
False |
warehouseId | The warehouse ID must reference an existing warehouse, and cannot be one of the reserved warehouse IDs (i.e. 1 or 2). This field cannot be modified if stock has been allocated for the order. | /warehouseId |
|
False |
delivery.shippingMethodId | The delivery method must reference an existing shipping method. If removed, will set to 0. | /delivery/shippingMethodId |
|
False |
delivery.deliveryDate | The delivery date field allows date to be set in 'yyyy-MM-dd' or in 'yyyy-MM-ddThh:mm:ss+|-hh:mm' formats. | /delivery/deliveryDate |
|
False |
parties.customer.contactId | The customer contact ID must be a valid customer. | /parties/customer/contactId |
|
False |
parties.billing.contactId | The billing contact ID must be a valid customer. | /parties/billing/contactId |
|
False |
Example
Updating order 45, remove shipping method, set warehouse ID to 4, set reference to 'ABB-1231', set customer contact ID to 201, set billing contact ID to 204 and set the team ID to 2.
Request URI
/order/45
Request body
[
{
"op": "replace",
"path": "/warehouseId",
"value": "4"
},
{
"op": "remove",
"path": "/delivery/shippingMethodId"
},
{
"op": "replace",
"path": "/reference",
"value": "ABB-1231"
},
{
"op": "replace",
"path": "/delivery/deliveryDate",
"value": "2018-07-17"
},
{
"op": "replace",
"path": "/parties/customer/contactId",
"value": "201"
},
{
"op": "replace",
"path": "/parties/billing/contactId",
"value": "204"
}
]