Orders

Orders are sales you made to customers that now need to be fulfilled.

1. Create an order. The order will be created with status 'concept'.
2. If desired, add tags to the order.
3. Mark the order as 'processing'. If the products are in stock, a picklist will be created automatically. If the products are not in stock, backorders will be created.

Attributes

The optional fields will be filled based on the selected customer, if fields are empty.

*) These fields are required, but if an idcustomer is provided Picqer will copy these fields from the customer object.

Get all orders

Filters

You can filter the orders with the following parameters. Add these filters as querystring parameters to the URL.

Get single order

Create new order

An order will always be created with status ‘concept’. Once the order has status 'concept', you can process it. Tags can be added after the order has been created.

You can also provide 'productcode' instead of 'idproduct' to create an order.

Create a guest order

Example of creating a guest order. Give idcustomer as null, but now you are required to provide the delivery and invoice name and address.

Update order

You can change the order after you created it. This is helpful if you want to change the delivery address or you want to change the shipping method.

Only some parameters can be changed: idcustomer, idtemplate, deliveryname, deliverycontactname, deliveryaddress, deliveryaddress2, deliveryzipcode, deliverycity, deliveryregion, deliverycountry, invoicename, invoicecontactname, invoiceaddress, invoiceaddress2, invoicezipcode, invoicecity, invoiceregion, invoicecountry, telephone, emailaddress, calculatevat, discount, pickup_point_data, preferred_delivery_date, customer_remarks, reference, invoiced, idshippingprovider_profile, partialdelivery, language

Process an order

Orders with the status 'expected' and 'concept' can be 'processed'. When you process an order it becomes final and cannot be edited anymore.

With processing Picqer will create a picklist or backorders for this order.

The processing itself will take place in the background after you received the response. This is why you still see the status 'concept' in the response. When you check back in after a minute or two, the order will be processed.

Pause order

Orders with the status 'processing' can be paused. For example, you can pause an order if the customer's address is incorrect, or if the customer contacts you to make changes to the order.

When you pause an order all underlying picklists will be paused, except if the picklist is snoozed. Future, newly created, picklists will also be automatically paused. Picklist that are unsnoozed will also be paused. Editing the order, as if it had the status 'processing', is still possible.

A reason for pausing is required. Read more about pausing in this support article

Resume order

Orders that have the status 'paused' can be resumed. When you resume an order, the order status is put back to 'processing'. All underlying picklists will be resumed. Read more about pausing and resuming here

Reopen an order

When you re-open an order, it will get the 'concept' status again and you can change the order. Only orders that are 'processing' without picklists can be reopend.

Cancel an order (delete)

Only orders with status 'concept' or 'expected' can be cancelled.

Forced cancelling

If you really want an order cancelled that is already processing or even completed, you can use the forced method. This will remove any attached picklists, even when they are already picked.

Re-open cancelled order

Only orders with status 'cancelled' can be used for undo cancellation.

Get status per order line

With this call you can get the status of all the order lines in the order. Per product you get the amount of products delivered, how many are in backorder, and how many are waiting to be picked.

Get notes from an order (deprecated)

Do not use this endpoint for new implementations as it will be removed in the near future. Use the comments api instead.

Orders can have notes, which will be shown in the interface at the order and picklists. It will also show up on the printed picklists. It will never be shown to the customer.

Add a note to an order (deprecated)

Do not use this endpoint for new implementations as it will be removed in the near future. Use the comments api instead.

Get tags from an order

Orders can have tags linked to them.

Add tag to order

Associate a tag with an order.

Remove tag from order

Allocate stock to concept order

When an order has the status 'concept', there is no stock reserved for the order. With 'allocating' you can tell Picqer to lower the free stock, so your webshop will only show the actual available stock.

De-allocate stock from concept order

When an order has allocated stock, you can release that allocation with a de-allocate.

Prioritise backorders of order

When an order has backorders, you can prioritize all backorders of this order by sending this request. Any available stock will first be used for these backorders.

Create picklist from available backorders of order

If there are available backorders, you can create a picklist for the available products by processing the backorders for a specific order. This will ignore the AutoSplit setting and always create a picklist for the available backorders.

Keep in mind that virtual compositions can only be placed on picklists if a whole composition is complete, so all parts are available for a composition.

Anonymize order

Orders older than 7 days can be anonymized. The name of the customer will be changed to 'Anonymous' and the addresses will be removed. If there is a customer linked to the order, the customer and any saved customer addresses will also be removed.

Documents regarding shipments and tracking URLs will be removed as well.

Products

You can use the endpoint /api/v1/orders/{idorder}/products to only get the details of ordered products for an order.

To add a new product to an existing order, you can POST that product with the following example.

You can only add 1 product per call. Required fields are: idproduct and amount. Picqer will auto-complete the name and price, but you can also override those. You can only add products to an order with status 'concept'.

To update a product, you can send a PUT request to endpoint /api/v1/orders/{idorder}/products/{idorder_product} to update name, price, amount or remarks. Amounts can only be changed if the order has status 'concept'.

To delete an ordered product, send a DELETE request to endpoint /api/v1/orders/{idorder}/products/{idorder_product}. You can only remove products from an order with the status 'concept'.

Orderfields

You can use the endpoint /api/v1/orders/{idorder}/orderfields to only get the details of orderfields for an order. We only show you orderfields that have values for this order.

You can add and update the value of orderfields with a PUT request with the idorderfield of an existing orderfield in the URL.

You can only add or update 1 orderfield per call. Required fields are: value.

To delete an orderfield for an order, send a DELETE request to endpoint /api/v1/orders/{idorder}/orderfields/{idorderfield}. You can only update the field to value `null` to remove the value of an orderfield.

Comments

Comments are supported on orders.