1. Order
  2. Order

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 add, modify or remove the value of one or more fields on an existing order. See our HTTP PATCH documentation for more information on how to use this method.

Field Description Path Allowed Operations
reference The customer/supplier reference field allows strings up to 64 characters. If removed, will be set to an empty string. /reference
  • replace
  • remove
warehouseId This field cannot be modified if stock has been allocated for the order. /warehouseId
  • replace
delivery.shippingMethodId The delivery method must reference an existing shipping method. If removed, will set to 0. /delivery/shippingMethodId
  • replace
  • remove
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
  • replace
parties.customer.contactId The customer contact ID must be a valid customer. Cannot be applied to an invoiced order. /parties/customer/contactId
  • replace
parties.billing.contactId The billing contact ID must be a valid customer. Cannot be applied to an invoiced order. /parties/billing/contactId
  • replace

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"
	}
]