Picqer API

https://picqer.com/en/api
Admin
The Picqer API provides a RESTful JSON-based interface for developers to extend and integrate...
Tokens:142,351
Snippets:837
Trust Score:9.1
Update:2 months ago
Show doc for...
Tokens:
Raw
### Retrieve configuration options via GET

Source: https://picqer.com/en/api/external-shipping-provider-integrations-technical

Example response structure for fetching shipping configuration options, including field definitions and default values.

```http
GET https://example.com/picqer-integration/config-options
HTTP/1.1 200 OK { "version": "1.0", "data": { "items": [ { "key": "shipping_method", "label": "Shipping method", "description": null, "type": "list", "possible_values": [ { "value": 29, "label": "DHLForYou" }, { "value": 928, "label": "DPD Global" } ], "default_value": 928, "required": true }, { "key": "sender_address", "label": "Sender", "description": "Used as sender address on label", "type": "list", "possible_values": [ { "value": 92828, "label": "Picqer B.V., Meander 601, Arnhem" }, { "value": 273682, "label": "Karwei, Delta 39, Arnhem" } ], "default_value": 92828 }, { "key": "insured", "label": "Insured", "description": null, "type": "list", "possible_values": [ { "value": 0, "label": "No" }, { "value": 1, "label": "Yes" } ], "default_value": 1 }, { "key": "pickup_instructions", "label": "Pickup instructions", "description": null, "type": "text", "default_value": null } ] } }
```

--------------------------------

### GET https://example.picqer.com/api/v1/returns

Source: https://picqer.com/en/api/returns

Retrieves a paginated list of all returns.

```APIDOC
## GET https://example.picqer.com/api/v1/returns

### Description
Retrieves a paginated list of all returns. This endpoint supports filtering by various attributes.

### Method
GET

### Endpoint
https://example.picqer.com/api/v1/returns

### Parameters
#### Query Parameters
- **search** (string) - Optional - Search through the fields returnid, reference, customer name and customer contact name.
- **status** (string) - Optional - Search for a specific idreturn_status, or use 'processing' or 'completed' to get all returns with statuses that are from the processing or completed type.
- **emailaddress** (string) - Optional - Get the returns that have this value as email address.
- **idcustomer** (integer) - Optional - Get all returns for this customer.
- **created_after** (string) - Optional - Get the returns that are created since this date and time (e.g., 2020-10-26 00:00:00).
- **updated_after** (string) - Optional - Get the returns that are changed since this date and time (e.g., 2020-10-26 00:00:00).

### Response
#### Success Response (200)
- **returns** (array) - A list of return objects.
```

--------------------------------

### Returns Webhook Payload Example

Source: https://picqer.com/en/api/webhook-examples

Example of a POST request sent to a webhook endpoint for the returns.products_received event.

```json
POST http(s)://example.com/your-endpoint
{ "idhook": 5201, "name": "Your name for this hook", "event": "returns.products_received", "event_triggered_at": "2019-12-04 10:14:33", "data": { "idreturn": 333748, "idreturn_status": 3722, "idcustomer": 12840632, "idorder": 27491572, "idtemplate": 2, "returnid": "R2019-1179", "name": "Elin van Waas", "contactname": null, "address": "Farahring 74y", "address2": null, "zipcode": "3055AK", "city": "Netterden", "region": "Limburg", "country": "NL", "full_address": "Elin van Waas\nFarahring 74y\n3055AK Netterden\nNederland", "telephone": null, "emailaddress": null, "language": "nl", "reference": "skikoffer #930518", "tracking_code": null, "received_at": null, "completed_at": null, "created_at": "2019-12-04 10:14:10", "updated_at": "2019-12-04 10:14:23", "idfulfilment_customer": null, "return_status": { "idreturn_status": 3722, "name": "In repair", "default": false, "completed": false, "color": "ff4444", "created_at": "2018-02-19 15:38:43", "updated_at": "2018-05-02 16:08:18", "deleted_at": null }, "customer": { "idcustomer": 12840632, "customerid": "67", "name": "Elin van Waas", "contactname": null }, "order": { "idorder": 27491572, "orderid": "ORD20199213", "reference": "skikoffer #930518", "created_at": "2019-11-09 13:57:48", "comment_count": 0 }, "returned_products": [ { "idreturn_product": 576833, "idreturn": 333748, "idreturn_reason": 2008, "idproduct": 11059182, "idwarehouse": null, "price": 5.31, "amount": 1, "status": "received", "changeable": true, "product": { "idproduct": 11059182, "image_url": "https://link-to-image.com/image2867/original", "productcode": "QU325476", "name": "HP R3000 Tripple" }, "return_reason": { "idreturn_reason": 2008, "name": "Wrong size" } } ], "replacement_products": [ { "idreturn_product_replacement": 122390, "idreturn": 333748, "idproduct": 11059176, "idpicklist": null, "price": 297.45, "amount": 1, "status": "concept", "changeable": true, "product": { "idproduct": 11059176, "image_url": "https://link-to-image.com/image2867/original", "productcode": "TT819682", "name": "Kraft Record Needle Banana Beach Replacement XL" } } ], "totals": { "returned_products_count": 1, "returned_products_value": 5.31, "returned_products_value_vat": 0.29, "replacement_products_count": 1, "replacement_products_value": 297.45, "replacement_products_value_vat": 51.62, "days_after_order_shipped": null } } }
HTTP/1.1 200 OK
```

--------------------------------

### GET https://example.picqer.com/api/v1/orders

Source: https://picqer.com/en/api/orders

Retrieves a list of all orders available in the system.

```APIDOC
## GET https://example.picqer.com/api/v1/orders

### Description
Retrieves a list of all orders from the Picqer system.

### Method
GET

### Endpoint
https://example.picqer.com/api/v1/orders

### Response
#### Success Response (200)
- **orders** (array) - A list of order objects containing details such as idorder, orderid, delivery information, status, and associated products.
```

--------------------------------

### GET /api/v1/picklists/{idpicklist}/packaging-advice

Source: https://picqer.com/en/api/picklists

Retrieves the packaging advice for a specific picklist.

```APIDOC
## GET /api/v1/picklists/{idpicklist}/packaging-advice

### Description
Retrieves the packaging advice associated with a picklist. If no advice exists, fields are returned with null values.

### Method
GET

### Endpoint
https://example.picqer.com/api/v1/picklists/{idpicklist}/packaging-advice

### Parameters
#### Path Parameters
- **idpicklist** (integer) - Required - The unique identifier of the picklist.

### Response
#### Success Response (200)
- **idpackaging** (integer) - The ID of the packaging.
- **source** (string) - The source of the advice.
- **created_at** (string) - Timestamp of creation.
- **updated_at** (string) - Timestamp of last update.
```

--------------------------------

### POST https://example.picqer.com/api/v1/products

Source: https://picqer.com/en/api/products

Creates a new product in the system.

```APIDOC
## POST https://example.picqer.com/api/v1/products

### Description
Creates a new product record with the provided details.

### Method
POST

### Endpoint
https://example.picqer.com/api/v1/products

### Parameters
#### Request Body
- **idvatgroup** (integer) - Required - VAT group ID
- **productcode** (string) - Required - Unique product code
- **name** (string) - Required - Product name
- **price** (number) - Required - Product price

### Request Example
{
  "idvatgroup": 18,
  "productcode": "883629-22",
  "name": "Hyperkewl Evaporative Cooling Vest Ultra Blue 7-9yr",
  "price": 54.46
}

### Response
#### Success Response (201)
- **idproduct** (integer) - The ID of the newly created product

#### Response Example
{
  "idproduct": 119692,
  "name": "Hyperkewl Evaporative Cooling Vest Ultra Blue 7-9yr",
  "price": 54.46
}
```

--------------------------------

### POST https://example.picqer.com/api/v1/returns

Source: https://picqer.com/en/api/returns

Creates a new return record. Note that virtual compositions are not supported; parts will be added individually instead.

```APIDOC
## POST https://example.picqer.com/api/v1/returns

### Description
Creates a new return, including returned and replacement products.

### Method
POST

### Endpoint
https://example.picqer.com/api/v1/returns

### Request Body
- **idreturn_status** (integer) - Required
- **idtemplate** (integer) - Required
- **name** (string) - Required
- **address** (string) - Required
- **zipcode** (string) - Required
- **city** (string) - Required
- **country** (string) - Required
- **emailaddress** (string) - Required
- **reference** (string) - Optional
- **returned_products** (array) - Optional - List of products being returned
- **replacement_products** (array) - Optional - List of replacement products

### Request Example
{
  "idreturn_status": 1,
  "idtemplate": 2,
  "name": "John Hendriks",
  "address": "Dorpsstraat 304",
  "zipcode": "8272 EM",
  "city": "Vlissingen",
  "country": "NL",
  "emailaddress": "john@example.org",
  "reference": "Order 23992",
  "returned_products": [
    { "idreturn_reason": 1, "idproduct": 1105257, "amount": 1 },
    { "idreturn_reason": 1, "idproduct": 1105258, "amount": 1 }
  ],
  "replacement_products": [
    { "idproduct": 1105250, "amount": 1 }
  ]
}

### Response
#### Success Response (201)
- **idreturn** (integer) - The unique identifier of the created return
- **returnid** (string) - The public return identifier

#### Response Example
{
  "idreturn": 4,
  "returnid": "R2017-1003",
  "name": "John Hendriks",
  "returned_products": [],
  "replacement_products": []
}
```

--------------------------------

### Get all orders

Source: https://picqer.com/en/api/orders

Retrieves a list of all orders from the system via a GET request.

```http
GET https://example.picqer.com/api/v1/orders
HTTP/1.1 200 OK [ { "idorder": 6576, "idcustomer": 5633, "idtemplate": 338, "idshippingprovider_profile": null, "orderid": "30130012", "deliveryname": "Triangle B.V.", "deliverycontactname": "Jos Triepels", "deliveryaddress": "Koppeling 15", "deliveryaddress2": null, "deliveryzipcode": "6983 HX", "deliverycity": "Doesburg", "deliveryregion": null, "deliverycountry": "NL", "full_delivery_address": "Triangle B.V.\nJos Triepels\nKoppeling 15\n6983 HX Doesburg\nNederland", "invoicename": "Triangle B.V.", "invoicecontactname": "Crediteurenadministratie", "invoiceaddress": "Koppeling 15", "invoiceaddress2": null, "invoicezipcode": "6983 HX", "invoicecity": "Doesburg", "invoiceregion": null, "invoicecountry": "NL", "full_invoice_address": "Triangle B.V.\nCrediteurenadministratie\nKoppeling 15\n6983 HX Doesburg\nNederland", "telephone": null, "emailaddress": null, "reference": null, "customer_remarks": null, "pickup_point_data": null, "partialdelivery": true, "auto_split": true, "invoiced": false, "preferred_delivery_date": null, "discount": 0, "calculatevat": true, "language": "nl", "status": "processing", "via_portal": false, "public_status_page": "https://example.picqer.com/s/eB1KLYRIN41p5xt2", "created": "2013-07-17 16:01:42", "updated": "2013-07-17 16:02:14", "warehouses": [ 1829, 2811 ], "tags": { "TopWebshop": { "idtag": 1075, "title": "TopWebshop", "color": "#5993be", "inherit": true, "textColor": "#000000" }, "SummerProducts": { "idtag": 1156, "title": "SummerProducts", "color": "#c7b4f6", "inherit": true, "textColor": "#000000" } }, "products": [ { "idorder_product": 86868, "idproduct": 633, "idvatgroup": 18, "productcode": "6531-RB-7-9", "name": "Hyperkewl Evaporative Cooling Vest Ultra Blue 7-9yr", "remarks": "", "price": 64.46, "amount": 1, "amount_cancelled": 0, "weight": 283, "partof_idorder_product": null, "has_parts": true }, { "idorder_product": 86869, "idproduct": 653, "idvatgroup": 18, "productcode": "6531-RE", "name": "Hyperkewl Evaporative Cooling Vest Ultra Blue 7-9yr", "remarks": "", "price": 164.46, "amount": 1, "amount_cancelled": 0, "weight": 1821, "partof_idorder_product": null, "has_parts": true } ], "pricelists": [], "picklists": [] }, { "idorder": 6754, "idcustomer": 5633, "orderid": "20130014", "deliveryname": "Triangle B.V.", "deliverycontactname": "Jos Triepels", "deliveryaddress": "Koppeling 15", "deliveryaddress2": null, "deliveryzipcode": "6983 HX", "deliverycity": "Doesburg", "deliveryregion": null, "deliverycountry": "NL", "full_delivery_address": "Triangle B.V.\nJos Triepels\nKoppeling 15\n6983 HX Doesburg\nNederland", "invoicename": "Triangle B.V.", "invoicecontactname": "Crediteurenadministratie", "invoiceaddress": "Koppeling 15", "invoiceaddress2": null, "invoicezipcode": "6983 HX", "invoicecity": "Doesburg", "invoiceregion": null, "invoicecountry": "NL", "full_invoice_address": "Triangle B.V.\nCrediteurenadministratie\nKoppeling 15\n6983 HX Doesburg\nNederland", "telephone": null, "emailaddress": null, "reference": null, "customer_remarks": null, "pickup_point_data": null, "partialdelivery": true, "auto_split": true, "invoiced": false, "preferred_delivery_date": null, "discount": 0, "calculatevat": true, "language": "nl", "status": "processing", "via_portal": false, "public_status_page": "https://example.picqer.com/s/eB1KLYRIN41p5xt2", "created": "2013-07-17 16:11:42", "updated": "2013-07-17 16:12:14", "warehouses": [ 1829, 2811 ], "tags": { "TopWebshop": { "idtag": 1075, "title": "TopWebshop", "color": "#5993be", "inherit": true, "textColor": "#000000" }, "SummerProducts": { "idtag": 1156, "title": "SummerProducts", "color": "#c7b4f6", "inherit": true, "textColor": "#000000" } }, "products": [ { "idorder_product": 86879, "idproduct": 633, "idvatgroup": 18, "productcode": "6531-RB-7-9", "name": "Hyperkewl Evaporative Cooling Vest Ultra Blue 7-9yr", "remarks": "", "price": 64.46, "amount": 1, "amount_cancelled": 0, "weight": 9828, "partof_idorder_product": null, "has_parts": true }, { "idorder_product": 86880, "idproduct": 653, "idvatgroup": 18, "productcode": "6531-RE", "name": "Hyperkewl Evaporative Cooling Vest Ultra Blue 7-9yr", "remarks": "", "price": 164.46, "amount": 1, "amount_cancelled": 0, "weight": 1821, "partof_idorder_product": null, "has_parts": true } ], "pricelists": [], "picklists": [ { "idpicklist": 53398250, "picklistid": "P2013-1832", "idcustomer": null, "idorder": 6754, "idreturn": null, "idwarehouse": 2811, "idtemplate": 6200, "idshippingprovider_profile": 12638, "deliveryname": "Triangle B.V.", "deliverycontact": "Jos Triepels", "deliveryaddress": "Koppeling 15", "deliveryaddress2": "", "deliveryzipcode": "6983 HX", "deliverycity": "Doesburg", "deliveryregion": "", "deliverycountry": "NL", "telephone": "", "emailaddress": "", "reference": "", "assigned_to_iduser": null, "invoiced": false, "urgent": true, "preferred_delivery_date": null, "status": "new", "totalproducts": 2, "totalpicked":
```

--------------------------------

### Get fulfilment customer report

Source: https://picqer.com/en/api/fulfilment-customer-reports

Retrieves the report for a specific fulfilment customer using a GET request.

```http
GET https://example.picqer.com/api/v1/fulfilment/customers/{idfulfilment_customer}/report

HTTP/1.1 200 OK { "meta_data": { "idfulfilment_customer": 1, "start_date": "2022-05-01", "end_date": "2022-05-31" }, "inbound": { "receipts_count": 0, "receipts_rows_count": 0, "receipts_products_total_amount": 0 }, "outbound": { "picklists_count": 2, "picklist_rows_count": 2, "picklist_products_count": 3, "shipments": [], "shipments_count": 0, "shipment_country_count": 0, "shipment_profile_count": 0 }, "storage_usage": { "stock_locations_in_use_count": 1, "stock_locations_in_use": [ { "idlocation": 24, "idwarehouse": 1, "warehouse_name": "Magazijn", "stock_location": "A.1.4.3", "unique_products": 1, "total_items": "12" } ], "stock_location_types_in_use": [ { "idwarehouse": 1, "warehouse_name": "Magazijn", "idlocation_type": 1, "name": "Standaard", "unique_locations": 1 } ], "products_total": 2, "stock_total": 1005 }, "returns": { "returns_count": 1, "return_rows_count": 2, "return_products_count": 7 } }
```

--------------------------------

### Install Picqer PHP Client via Composer

Source: https://picqer.com/en/api/php-client

Use this command to add the Picqer API client library to your PHP project dependencies.

```bash
composer require picqer/api-client
```

--------------------------------

### Orders.* Webhook Payload Example

Source: https://picqer.com/en/api/webhook-examples

Example of a POST request payload sent to a webhook endpoint for an orders.allocated event.

```http
POST http(s)://example.com/your-endpoint
{ "idhook": 30088, "name": "Your name for this hook", "event": "orders.allocated", "event_triggered_at": "2026-01-13 09:46:30", "data": { "idorder": 240350427, "idcustomer": 120968508, "idtemplate": 13207, "idshippingprovider_profile": null, "orderid": "O2026-1002", "deliveryname": "Amelia van Geest", "deliverycontactname": null, "deliveryaddress": "van der Lindensteeg 88-65", "deliveryaddress2": null, "deliveryzipcode": "5231PS", "deliverycity": "Echtenerbrug", "deliveryregion": "Utrecht", "deliverycountry": "NL", "full_delivery_address": "Amelia van Geest\nvan der Lindensteeg 88-65\n5231PS Echtenerbrug\nNederland", "invoicename": "Amelia van Geest", "invoicecontactname": null, "invoiceaddress": "van der Lindensteeg 88-65", "invoiceaddress2": null, "invoicezipcode": "5231PS", "invoicecity": "Echtenerbrug", "invoiceregion": "Utrecht", "invoicecountry": "NL", "full_invoice_address": "Amelia van Geest\nvan der Lindensteeg 88-65\n5231PS Echtenerbrug\nNederland", "telephone": null, "emailaddress": null, "reference": null, "customer_remarks": null, "pickup_point_data": null, "partialdelivery": true, "auto_split": true, "invoiced": false, "preferred_delivery_date": null, "discount": 0, "calculatevat": true, "language": "nl", "status": "concept", "paused_reason": null, "via_portal": false, "public_status_page": "https://example.picqer.com/s/lJrdR8xXEyys9mp0oafYaPA38y8Au680", "created": "2026-01-13 09:46:28", "updated": "2026-01-13 09:46:28", "idfulfilment_customer": null, "warehouses": [ 12390, 12452 ], "tags": [], "products": [ { "idorder_product": 583178440, "idproduct": 47231912, "idvatgroup": 25004, "productcode": "kopjekoffie", "name": "kopje koffie", "remarks": null, "price": 4.13, "amount": 1, "amount_cancelled": 0, "weight": null, "partof_idorder_product": null, "has_parts": false } ], "orderfields": [], "picklists": [], "comment_count": 0 } }
HTTP/1.1 200 OK
```

--------------------------------

### Get packaging advice for a picklist

Source: https://picqer.com/en/api/picklists

Retrieves packaging advice for a picklist. Returns null values if no advice is available.

```http
GET https://example.picqer.com/api/v1/picklists/{idpicklist}/packaging-advice
HTTP/1.1 200 OK { "idpackaging": 34, "source": "automatic", "created_at": "2025-06-25 14:21:14", "updated_at": "2025-06-25 14:21:14" } 
```

--------------------------------

### GET /api/v1/location_types

Source: https://picqer.com/en/api/locationtypes

Retrieve a list of all location types.

```APIDOC
## GET /api/v1/location_types

### Description
Retrieve a list of all location types.

### Method
GET

### Endpoint
https://example.com/api/v1/location_types

### Response
#### Success Response (200)
- **idlocation_type** (integer) - Unique identifier for the location type
- **name** (string) - Name of the location type
- **default** (boolean) - Indicates whether this location type is the default type
- **color** (string) - Color code for the location type

#### Response Example
[ { "idlocation_type": 1, "name": "Standard", "default": true, "color": "#1E90FF" }, { "idlocation_type": 2, "name": "Bulk Storage", "default": false, "color": "#32CD32" } ]
```

--------------------------------

### POST https://example.picqer.com/api/v1/backorders/process

Source: https://picqer.com/en/api/backorders

Process available backorders to generate picklists.

```APIDOC
## POST https://example.picqer.com/api/v1/backorders/process

### Description
This will generate picklists for all available backorders.

### Method
POST

### Endpoint
https://example.picqer.com/api/v1/backorders/process
```

--------------------------------

### GET /api/v1/return_reasons

Source: https://picqer.com/en/api/returns

Retrieves a list of all possible return reasons.

```APIDOC
## GET /api/v1/return_reasons

### Description
You can use this endpoint to retrieve a list of all possible return reasons.

### Method
GET

### Endpoint
https://example.picqer.com/api/v1/return_reasons

### Response
#### Success Response (200)
- **idreturn_reason** (integer) - The unique identifier for the reason.
- **name** (string) - The name of the reason.
- **default** (boolean) - Whether this is the default reason.
- **created_at** (string) - Timestamp of creation.
- **updated_at** (string) - Timestamp of last update.
- **deleted_at** (string|null) - Timestamp of deletion if applicable.

#### Response Example
[
  {
    "idreturn_reason": 11913,
    "name": "Wrong product",
    "default": true,
    "created_at": "2025-10-02 15:47:35",
    "updated_at": "2025-10-02 15:47:35",
    "deleted_at": null
  }
]
```

--------------------------------

### POST https://example.com/api/v1/tasks

Source: https://picqer.com/en/api/tasks

Create a new task in the system.

```APIDOC
## POST https://example.com/api/v1/tasks

### Description
Create a new task. Only the listed fields can be provided; other fields like idtask, created_at, etc., are automatically generated by the system.

### Method
POST

### Endpoint
https://example.com/api/v1/tasks

### Parameters
#### Request Body
- **title** (string) - Required - Title of the task
- **description** (string) - Optional - Detailed description of the task
- **deadline_date** (date) - Optional - Deadline date for the task
- **deadline_time** (time) - Optional - Specific deadline time for the task
- **assigned_to_iduser** (integer) - Optional - ID of the user to whom the task is assigned

### Request Example
{ "title": "Restock Shelf A-12", "description": "Refill with 50 units of product XYZ", "deadline_date": "2025-03-04", "deadline_time": "23:59:00", "assigned_to_iduser": 2 }

### Response
#### Success Response (201)
- **idtask** (integer) - Task ID
- **title** (string) - Task title
- **description** (string) - Task description
- **assigned_to_iduser** (integer) - ID of the assigned user
- **is_seen_by_assignee** (boolean) - Whether the assignee has seen the task
- **deadline_date** (string) - Deadline date
- **deadline_time** (string) - Deadline time
- **completed_at** (string) - Completion timestamp
- **completed_by_iduser** (integer) - ID of the user who completed the task
- **created_by_iduser** (integer) - ID of the user who created the task
- **created_at** (string) - Creation timestamp
- **updated_at** (string) - Last update timestamp

### Response Example
{ "idtask": 26, "title": "Restock Shelf A-12", "description": "Refill with 50 units of product XYZ", "assigned_to_iduser": 2, "is_seen_by_assignee": false, "deadline_date": "2025-03-04 00:00:00", "deadline_time": "23:59:00", "completed_at": null, "completed_by_iduser": null, "created_by_iduser": 2, "created_at": "2025-02-25 10:00:00", "updated_at": "2025-02-25 10:00:00" }
```

--------------------------------

### GET /api/v1/return_statuses

Source: https://picqer.com/en/api/returns

Retrieves a list of all possible return statuses.

```APIDOC
## GET /api/v1/return_statuses

### Description
You can use this endpoint to retrieve a list of all possible return statuses.

### Method
GET

### Endpoint
https://example.picqer.com/api/v1/return_statuses

### Response
#### Success Response (200)
- **idreturn_status** (integer) - The unique identifier for the status.
- **name** (string) - The name of the status.
- **default** (boolean) - Whether this is the default status.
- **completed** (boolean) - Whether this status marks the return as completed.
- **color** (string) - The hex color code associated with the status.
- **created_at** (string) - Timestamp of creation.
- **updated_at** (string) - Timestamp of last update.
- **deleted_at** (string|null) - Timestamp of deletion if applicable.

#### Response Example
[
  {
    "idreturn_status": 15126,
    "name": "Received",
    "default": true,
    "completed": false,
    "color": "1db0de",
    "created_at": "2025-10-02 15:25:01",
    "updated_at": "2025-10-02 15:25:01",
    "deleted_at": null
  }
]
```

--------------------------------

### GET https://example.picqer.com/api/v1/returns/{idreturn}

Source: https://picqer.com/en/api/returns

Retrieves detailed information for a single return, including associated customer, order, and product details.

```APIDOC
## GET https://example.picqer.com/api/v1/returns/{idreturn}

### Description
Retrieves detailed information for a specific return. The response includes nested details for return_status, customer, order, returned_products, and replacement_products.

### Method
GET

### Endpoint
https://example.picqer.com/api/v1/returns/{idreturn}

### Parameters
#### Path Parameters
- **idreturn** (integer) - Required - The unique identifier of the return.

### Response
#### Success Response (200)
- **idreturn** (integer) - The return ID.
- **return_status** (object) - Details of the return status.
- **customer** (object) - Details of the customer.
- **order** (object) - Details of the associated order.
- **returned_products** (array) - List of products being returned.
- **replacement_products** (array) - List of replacement products.
- **totals** (object) - Summary of return totals.
```

--------------------------------

### POST https://example.picqer.com/api/v1/orders

Source: https://picqer.com/en/api/orders

Creates a new guest order. When idcustomer is null, delivery and invoice details must be provided.

```APIDOC
## POST https://example.picqer.com/api/v1/orders

### Description
Creates a new guest order. Requires delivery and invoice information when idcustomer is set to null.

### Method
POST

### Endpoint
https://example.picqer.com/api/v1/orders

### Request Body
- **idcustomer** (null) - Required
- **deliveryname** (string) - Required
- **deliveryaddress** (string) - Required
- **deliveryzipcode** (string) - Required
- **deliverycity** (string) - Required
- **deliverycountry** (string) - Required
- **invoicename** (string) - Required
- **invoiceaddress** (string) - Required
- **invoicezipcode** (string) - Required
- **invoicecity** (string) - Required
- **invoicecountry** (string) - Required
- **products** (array) - Required

### Request Example
{ "idcustomer": null, "deliveryname": "John Strijbos", "deliveryaddress": "Vrije Water 12", "deliveryzipcode": "3928 DM", "deliverycity": "Zeist", "deliverycountry": "nl", "invoicename": "John Strijbos", "invoiceaddress": "Vrije Water 12", "invoicezipcode": "3928 DM", "invoicecity": "Zeist", "invoicecountry": "nl", "products": [ { "idproduct": 633, "amount": 1 } ] }
```

--------------------------------

### GET /api/v1/templates

Source: https://picqer.com/en/api/templates

Retrieves a list of all templates configured for the company.

```APIDOC
## GET /api/v1/templates

### Description
Retrieves a list of all templates configured for the company.

### Method
GET

### Endpoint
https://example.picqer.com/api/v1/templates

### Response
#### Success Response (200)
- **idtemplate** (integer) - Unique Picqer reference
- **name** (string) - The name you gave to this template
- **custom_css** (string) - Custom CSS added to this template
- **default** (boolean) - Whether this template is the default template

#### Response Example
[
  {
    "idtemplate": 6200,
    "name": "Standaard",
    "custom_css": "",
    "default": true
  }
]
```

--------------------------------

### Get a warehouse

Source: https://picqer.com/en/api/warehouses

Retrieves details for a specific warehouse by its ID.

```http
GET https://example.picqer.com/api/v1/warehouses/{idwarehouse}
HTTP/1.1 200 OK { "idwarehouse":321, "name":"Marconistraat", "accept_orders": true, "counts_for_general_stock": true, "priority": 1, "active":true }
```

--------------------------------

### POST https://example.picqer.com/api/v1/customers

Source: https://picqer.com/en/api/customers

Creates a new customer record in the system.

```APIDOC
## POST https://example.picqer.com/api/v1/customers

### Description
Creates a new customer record with the provided contact information and address details.

### Method
POST

### Endpoint
https://example.picqer.com/api/v1/customers

### Request Body
- **name** (string) - Required - The name of the customer.
- **contactname** (string) - Optional - The contact person's name.
- **telephone** (string) - Optional - The telephone number.
- **emailaddress** (string) - Optional - The email address.
- **addresses** (array) - Required - List of address objects.

### Request Example
{
  "name": "Desmonds Formal Wear",
  "contactname": "van Lingen",
  "telephone": "06-85756303",
  "emailaddress": "demo@mailinator.com",
  "addresses": [
    {
      "name": "Argus Tapes & Records",
      "address": "Weijkmanlaan 68",
      "zipcode": "7077 AP",
      "city": "Netterden",
      "country": "nl",
      "defaultinvoice": true,
      "defaultdelivery": true
    }
  ]
}

### Response
#### Success Response (201)
- **idcustomer** (integer) - The unique ID of the newly created customer.
```

--------------------------------

### GET /api/v1/packingstations

Source: https://picqer.com/en/api/packingstations

Retrieve a list of all available packing stations.

```APIDOC
## GET /api/v1/packingstations

### Description
Retrieve a list of all packing stations.

### Method
GET

### Endpoint
https://example.com/api/v1/packingstations

### Response
#### Success Response (200)
- **idpacking_station** (integer) - Unique identifier for the packing station
- **name** (string) - Name of the packing station
- **printer_packinglists** (Printer) - Printer to use for packing lists
- **printer_shipping_labels** (Printer) - Printer to use for shipping labels
- **printer_shipping_documents** (Printer) - Printer to use for shipping documents
- **printer_product_labels** (Printer) - Printer to use for product labels

#### Response Example
[
  {
    "idpacking_station": 1,
    "name": "Paktafel 1",
    "printer_packinglists": null,
    "printer_shipping_labels": null,
    "printer_shipping_documents": null,
    "printer_product_labels": {
      "idprinter": 1,
      "name": "Paktafel 1 barcode printer",
      "format": "custom",
      "custom_width": 95,
      "custom_height": 30,
      "zpl_support": false,
      "printnode_printerid": 10000001
    }
  }
]
```

--------------------------------

### POST https://example.picqer.com/api/v1/purchaseorders

Source: https://picqer.com/en/api/purchaseorders

Creates a new purchase order in the system.

```APIDOC
## POST https://example.picqer.com/api/v1/purchaseorders

### Description
Creates a new purchase order.

### Method
POST

### Endpoint
https://example.picqer.com/api/v1/purchaseorders

### Request Body
- **idsupplier** (integer) - Required - The ID of the supplier.
- **idwarehouse** (integer) - Required - The ID of the warehouse.
- **products** (array) - Required - List of products to include in the order.

### Response
#### Success Response (201)
- **idpurchaseorder** (integer) - The ID of the newly created purchase order.
```

--------------------------------

### GET /api/v1/fulfilment/customers

Source: https://picqer.com/en/api/fulfilment-customers

Retrieve a paginated list of all fulfilment customers.

```APIDOC
## GET /api/v1/fulfilment/customers

### Description
Retrieve a paginated list of all fulfilment customers.

### Method
GET

### Endpoint
https://example.picqer.com/api/v1/fulfilment/customers

### Response
#### Success Response (200)
- **Response** (array) - List of fulfilment customer objects.
```

--------------------------------

### GET https://example.picqer.com/api/v1/products/{idproduct}

Source: https://picqer.com/en/api/products

Retrieves the details of a single product by its unique identifier.

```APIDOC
## GET https://example.picqer.com/api/v1/products/{idproduct}

### Description
Retrieves the full details of a specific product identified by its ID.

### Method
GET

### Endpoint
https://example.picqer.com/api/v1/products/{idproduct}

### Parameters
#### Path Parameters
- **idproduct** (integer) - Required - The unique identifier of the product.

### Response
#### Success Response (200)
- **idproduct** (integer) - Product ID
- **name** (string) - Product name
- **price** (number) - Product price
- **productcode** (string) - Product code
- **barcode** (string) - Product barcode
- **active** (boolean) - Whether the product is active

#### Response Example
{
  "idproduct": 633,
  "name": "Hyperkewl Evaporative Cooling Vest Ultra Blue 7-9yr",
  "price": 54.46,
  "productcode": "6531-RB-7-9",
  "barcode": "857825001442",
  "active": true
}
```

--------------------------------

### GET /customerfields

Source: https://picqer.com/en/api/customerfields

Retrieves a list of all available customer fields.

```APIDOC
## GET /customerfields

### Description
Retrieves a list of all customer fields defined in the system. This endpoint supports pagination.

### Method
GET

### Endpoint
https://example.picqer.com/api/v1/customerfields

### Response
#### Success Response (200)
- **idcustomerfield** (integer) - Unique Picqer reference
- **title** (string) - Title of customerfield
- **type** (text) - Type of field
- **values** (array) - Possible values
- **required** (boolean) - Is this field required

#### Response Example
[ { "idcustomerfield":103, "title":"Afleveropties", "type":"text", "values":[], "required":true } ]
```

--------------------------------

### GET /picklists/{idpicklist}/packinglistpdf

Source: https://picqer.com/en/api/picklists

Retrieves the PDF of a packing list.

```APIDOC
## GET /picklists/{idpicklist}/packinglistpdf

### Description
Retrieves the PDF of a packing list. Similar to the picklist PDF endpoint, it returns JSON if Accept: application/json is provided, otherwise returns the PDF document directly.

### Method
GET

### Endpoint
https://example.picqer.com/api/v1/picklists/{idpicklist}/packinglistpdf

### Parameters
#### Path Parameters
- **idpicklist** (string) - Required - The ID of the picklist.
```

--------------------------------

### GET https://example.picqer.com/api/v1/products

Source: https://picqer.com/en/api/products

Retrieves a list of products. By default, this returns active products, but can be configured to return inactive products or filtered by various attributes.

```APIDOC
## GET https://example.picqer.com/api/v1/products

### Description
Retrieves a list of products. This endpoint supports pagination and various filtering options via query parameters.

### Method
GET

### Endpoint
https://example.picqer.com/api/v1/products

### Parameters
#### Query Parameters
- **inactive** (boolean) - Optional - Set to true to get inactive products. Omit to get active products.
- **tag** (string) - Optional - Filter products by tag name.
- **type** (string) - Optional - Filter by product type (normal, unlimited_stock, virtual_composition, composition_with_stock).
- **productcode** (string) - Optional - Filter by specific product code.
- **idsupplier** (integer) - Optional - Filter by supplier ID.
- **idproducts** (string) - Optional - Comma-separated list of specific product IDs.
- **search** (string) - Optional - Fuzzy search through name, product code, supplier product code, and barcode.
- **idfulfilment_customer** (integer) - Optional - Filter by fulfilment customer ID.

### Response
#### Success Response (200)
- **Array** (object) - A list of product objects.
```
Tokens:
Raw