Order
The order service provides functionality for managing the sales orders, sales credits, purchase orders and purchase credits in your system.
With this service you can create and modify the resources listed below. The primary resource managed by this service is the order which represents each type of order as a uniform resource distinguished by the orderTypeCode. This is a very low level resource and requires multiple calls to create simple orders. For order types that have more specialized resources available, integrators should prefer to use those.
Integrations creating sales orders should prefer the sales order resource which has the benefit of being atomic: the order will be fully created or not created. With one call, the integration can create a complete sales order with all order rows attached and a resulting sales-order.created resource event will fire. Reception of this event (via a webhook) means that the sales order is fully created and available.
Sales orders created as sales order resources can still be manipulated using the order resource endpoints after creation. Changes to rows and status for example, still apply to sales orders.
Resources
| Order custom fields are user-defined data held against an order. Custom fields are defined separately for sales and purchase orders. Field names and data types are shared between every order of the same type. Several data types are available. ... | |
| Obfuscates contact details from orders. Optionally, it can keep city and state information. | |
| A landed cost estimate is the a cost incurred when of receiving goods into inventory, these costs are entered against rows on a purchase order and then allocate to goods when they are received into stock ... | |
| An order represents an exchange of goods or services between your company and a supplier, or between your company and a customer. The order resource allows manipulation of sales orders, sales credits, purchase orders and purchase credits. ... | |
| An Order Acknowledgement represents a supplier's acknowledgement that they have to fulfil a Brightpearl order. | |
| Order custom fields are user-defined data held against an order. Custom fields are defined separately for sales and purchase orders. Field names and data types are shared between every order of the same type. Several data types are available. ... | |
| An Order Note represents a note against a Brightpearl order. | |
| An order now represents a line on an order. | |
| Order shipping status codes indicate the shipping status of a sale, credit or purchase. These codes are consistent across all Brightpearl accounts but we use the three letter codes in Order GET responses. This API allows you to convert between ... | |
| An order status is used to indicate the state of an order. | |
| An Order Status represents the status of an order in Brightpearl. | |
| Order stock status codes indicate the fulfilment status of a sale, credit or purchase. These codes are consistent across all Brightpearl accounts but we use the three letter codes in Order GET responses and require the integer IDs in Order ... | |
| Order type codes are used to identify the types of orders returned by the Order GET and Order SEARCH APIs - sales orders, sales credits, purchase orders and purchase credits. These codes are consistent across all Brightpearl accounts but we ... | |
| A Purchase Credit Close Resource is an operational resource representing the action of invoicing and closing a purchase credit to further edits within Brightpearl. | |
| A Purchase Order Close Resource is an operational resource representing the action of invoicing and closing a purchase order to further edits within Brightpearl. | |
| A sales credit represents an exchange of goods or services between your company and a customer. The sales credit resource allows manipulation of sales credits. | |
| A Sales Credit Close Resource is an operational resource representing the action of invoicing and closing a sales credit to further edits within Brightpearl. | |
| A sales order represents an exchange of goods or services between your company and a customer. The sales order resource allows manipulation of sales orders. | |
| A Sales Order Close Resource is an operational resource representing the action of invoicing and closing a sales order to further edits within Brightpearl. | |
| A sales order row represents a line on a sales order. |