Itsperfect API 3.0

https://itsperfect.stoplight.io
Admin
Itsperfect API 3.0 is a REST API for the Itsperfect ERP system that enables GET, POST, PUT, and...
Tokens:6,987
Snippets:56
Trust Score:10
Update:6 months ago
Show doc for...
Tokens:
Raw
### HTTP Response with Rate Limit Headers

Source: https://itsperfect.stoplight.io/docs/itsperfect/xxwvu1j3kqriq-rate-limits

Example of a successful HTTP response containing rate limit information.

```http
HTTP/1.1 200 OK
X-Bucket-Size: 100
X-Marbles-In-Bucket: 75
X-Remaining-Requests: 25
Content-Type: application/json
```

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

### POST /api/v3/sales_return_pre_announcements

Source: https://itsperfect.stoplight.io/docs/itsperfect/ez9isnk87ejgw-connect-a-return-portal

Allows for the creation of a sales return pre-announcement, with an option to issue a refund via gift card. The gift card will be automatically created in Itsperfect upon receiving the return. This example demonstrates creating a gift card with 5% of the return value.

```APIDOC
## POST /api/v3/sales_return_pre_announcements

### Description
Creates a sales return pre-announcement and optionally issues a refund via gift card.

### Method
POST

### Endpoint
/api/v3/sales_return_pre_announcements

### Request Body
- **sales_order** (object) - Required - Details of the sales order.
  - **id** (integer) - Required - The ID of the sales order.
- **return_number** (string) - Required - The return number.
- **refund_via_giftcard** (integer) - Required - Flag to indicate refund via gift card (1 for yes, 0 for no).
- **giftcard_store_credits** (object) - Optional - Details for gift card store credits.
  - **type** (integer) - Required - Type of gift card credit.
  - **value** (integer) - Required - The value of the gift card credit.
- **lines** (array) - Required - Array of return lines.
  - **type** (string) - Required - Type of line item (e.g., "return").
  - **barcode** (string) - Required - Barcode of the item.
  - **return_reason_id** (integer) - Required - ID of the return reason.
  - **quantity** (integer) - Required - Quantity of the item being returned.

### Request Example
```json
{
    "sales_order": {"id" : 1350},
    "return_number": "3SABCD123456789",
    "refund_via_giftcard": 1,
    "giftcard_store_credits": {
        "type": 1,
        "value": 5
    },
    "lines": [
        {
            "type": "return",
            "barcode": "4273492000001",
            "return_reason_id": 4,
            "quantity": 1
        }
    ]
}
```

### Response
#### Success Response (200)
- **message** (string) - Description of the success response.

#### Response Example
```json
{
  "message": "Return pre-announcement created successfully."
}
```
```

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

### API Filtering Syntax and Usage

Source: https://itsperfect.stoplight.io/docs/itsperfect/8jg1djbaru2mb-filtering

Overview of the filtering syntax and examples of how to apply filters to API endpoints.

```APIDOC
## Filtering Syntax

| Syntax | Description |
| --- | --- |
| = | Equals to |
| > | Greater than |
| < | Less than |
| >= | Greater than or equal to |
| <= | Less than or equal to |
| != | Not equal to |
| IN | Allows filtering by multiple values at once |

### Examples

- **Filter by status (Equals)**: `/api/v3/items?status=2`
- **Filter by multiple statuses (IN)**: `/api/v3/items?status IN (1,2)`
- **Filter by date (Greater than)**: `/api/v3/items/{id}/stock?availability_timestamp>2025-03-10 15:50:30`
- **Combining multiple filters**: `/api/v3/items/{id}/stock?warehouse_id=1&economical_stock>0`
```

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

### Rate Limit Header Examples

Source: https://itsperfect.stoplight.io/docs/itsperfect/xxwvu1j3kqriq-rate-limits

Individual headers used to communicate bucket capacity and remaining request limits.

```http
X-Bucket-Size: 100
```

```http
X-Marbles-In-Bucket: 75
```

```http
X-Remaining-Requests: 25
```

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

### Create Gift Card Refund

Source: https://itsperfect.stoplight.io/docs/itsperfect/ez9isnk87ejgw-connect-a-return-portal

Use this endpoint to generate a gift card for a customer's return. The gift card will be automatically created in Itsperfect. This example adds 5% of the return value as store credits to the gift card.

```json
{
    "sales_order": {"id" : 1350},
    "return_number": "3SABCD123456789",
    "refund_via_giftcard": 1,
    "giftcard_store_credits": {
        "type": 1,
        "value": 5
    },
    "lines": [
        {
            "type": "return",
            "barcode": "4273492000001",
            "return_reason_id": 4,
            "quantity": 1
        }
    ]
}
```

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

### GET /api/v3/puts

Source: https://itsperfect.stoplight.io/docs/itsperfect/m6r83djacm7cl-connect-an-external-warehouse-3-pl

Download goods receipts (purchase orders, B2B returns) that have not yet been synchronized.

```APIDOC
## GET /api/v3/puts

### Description
Download goods receipts that have not yet been synchronized for a specific warehouse.

### Method
GET

### Endpoint
/api/v3/puts

### Parameters
#### Query Parameters
- **warehouse_id** (integer) - Required - The ID of the warehouse.
- **logistic_connector_status** (integer) - Required - Set to 0 for unsynchronized items.
- **includes** (string) - Optional - Set to 'lines' to include receipt lines.
```

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

### Filter API Results

Source: https://itsperfect.stoplight.io/docs/itsperfect/8jg1djbaru2mb-filtering

Examples of applying different filter operators to API query parameters.

```text
/api/v3/items?status=2
```

```text
/api/v3/items?status IN (1,2)
```

```text
/api/v3/items/{id}/stock?availability_timestamp>2025-03-10 15:50:30
```

```text
/api/v3/items/{id}/stock?warehouse_id=1&economical_stock>0
```

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

### GET /api/v3/picks

Source: https://itsperfect.stoplight.io/docs/itsperfect/m6r83djacm7cl-connect-an-external-warehouse-3-pl

Download deliveries (sales orders, transit orders) that have not yet been synchronized.

```APIDOC
## GET /api/v3/picks

### Description
Download deliveries that have not yet been synchronized for a specific warehouse.

### Method
GET

### Endpoint
/api/v3/picks

### Parameters
#### Query Parameters
- **warehouse_id** (integer) - Required - The ID of the warehouse.
- **logistic_connector_status** (integer) - Required - Set to 0 for unsynchronized items.
- **includes** (string) - Optional - Set to 'lines' to include delivery lines.
```

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

### GET /api/v3/sales_return_pre_announcements/{preAnnounchementId}

Source: https://itsperfect.stoplight.io/docs/itsperfect/ez9isnk87ejgw-connect-a-return-portal

Fetches the details of a specific return pre-announcement, including the Exchange Order ID if applicable.

```APIDOC
## GET /api/v3/sales_return_pre_announcements/{preAnnounchementId}

### Description
Fetches the details of a specific return pre-announcement, including the Exchange Order ID if applicable.

### Method
GET

### Endpoint
/api/v3/sales_return_pre_announcements/{preAnnounchementId}

### Parameters
#### Path Parameters
- **preAnnounchementId** (integer) - Required - The ID of the pre-announcement to retrieve.

### Response
#### Success Response (200)
- **exchangeOrderId** (integer) - The ID of the exchange order, if created.

#### Response Example
```json
{
  "exchangeOrderId": 67890
}
```
```

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

### GET /api/v3/items

Source: https://itsperfect.stoplight.io/docs/itsperfect/m6r83djacm7cl-connect-an-external-warehouse-3-pl

Retrieve items from the system, including barcode information. Supports filtering by last update timestamp.

```APIDOC
## GET /api/v3/items

### Description
Retrieve all items, including barcodes. Use the last_update_timestamp parameter to fetch changes and new items since the last synchronization.

### Method
GET

### Endpoint
/api/v3/items

### Parameters
#### Query Parameters
- **includes** (string) - Optional - Set to 'barcodes' to include barcode data.
- **last_update_timestamp** (string) - Optional - Filter items updated after this timestamp (format: YYYY-MM-DD HH:MM:SS).
```

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

### Create Regular Return Pre-announcement

Source: https://itsperfect.stoplight.io/docs/itsperfect/ez9isnk87ejgw-connect-a-return-portal

Use this POST request to create a regular return pre-announcement. Configure return costs using `fixed_return_cost_fcy` and `return_cost_per_unit_fcy`. The `return_number` is the track & trace number from the return portal.

```json
{
    "sales_order": {"id" : 1350},
    "fixed_return_cost_fcy": "1.50",
    "return_cost_per_unit_fcy": "0.25",
    "return_number": "3SABCD123456789",
    "refund_via_giftcard": 1,
    "lines": [
        {
            "type": "return",
            "barcode": "4273492000001",
            "return_reason_id": 4,
            "quantity": 1
        }
    ]
}
```

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

### Create Commercial Exchange Pre-announcement

Source: https://itsperfect.stoplight.io/docs/itsperfect/ez9isnk87ejgw-connect-a-return-portal

Register a commercial exchange by creating a pre-announcement. This immediately generates a new exchange order. Once the return is received, the exchange order is released, and a pick order is sent to the warehouse. No refund is triggered to the webshop for exchanges.

```json
{
    "sales_order": {"id" : 1350},
    "return_number": "3SABCD123456789",
    "refund_via_giftcard": 1,
    "lines": [
        {
            "type": "exchange",
            "barcode": "4273492000001",
            "return_reason_id": 4,
            "quantity": 1,
            "exchange": {
                "barcode": "4273492000124",
                "item_id": 44,
                "color_id": 4,
                "size_id": 17
            }
        }
    ]
}
```

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

### Manage Deliveries (Picks)

Source: https://itsperfect.stoplight.io/docs/itsperfect/m6r83djacm7cl-connect-an-external-warehouse-3-pl

Endpoints for downloading pending picks and marking them as synchronized.

```text
/api/v3/picks?warehouse_id=1&logistic_connector_status=0&includes=lines
```

```json
{
  "document_type": "pick",
  "document_id": "270",
  "status": "success",
  "reference": "4567865"
}
```

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

### POST /api/v3/sales_return_pre_announcements - Regular Pre-announcement

Source: https://itsperfect.stoplight.io/docs/itsperfect/ez9isnk87ejgw-connect-a-return-portal

Creates a pre-announcement for a return. This endpoint should be used for all return registrations from an external portal to avoid duplicate returns. It allows linking return reasons and managing return costs.

```APIDOC
## POST /api/v3/sales_return_pre_announcements

### Description
Creates a pre-announcement for a return. This endpoint should be used for all return registrations from an external portal to avoid duplicate returns. It allows linking return reasons and managing return costs.

### Method
POST

### Endpoint
/api/v3/sales_return_pre_announcements

### Parameters
#### Request Body
- **sales_order** (object) - Required - The original sales order in Itsperfect.
  - **id** (integer) - Required - The ID of the sales order.
- **fixed_return_cost_fcy** (string) - Optional - Fixed return costs in the order currency, deducted from the refund.
- **return_cost_per_unit_fcy** (string) - Optional - Variable return costs per item in the order currency, deducted from the refund.
- **return_number** (string) - Required - The track & trace number created by the return portal.
- **refund_via_giftcard** (integer) - Optional - Indicates if the refund should be processed via a gift card (1 for yes, 0 for no).
- **lines** (array) - Required - An array of return lines.
  - **type** (string) - Required - Type of line item, should be 'return'.
  - **barcode** (string) - Required - Barcode of the item being returned.
  - **return_reason_id** (integer) - Required - The ID of the return reason.
  - **quantity** (integer) - Required - The quantity of the item being returned.

### Request Example
```json
{
    "sales_order": {"id" : 1350},
    "fixed_return_cost_fcy": "1.50",
    "return_cost_per_unit_fcy": "0.25",
    "return_number": "3SABCD123456789",
    "refund_via_giftcard": 1,
    "lines": [
        {
            "type": "return",
            "barcode": "4273492000001",
            "return_reason_id": 4,
            "quantity": 1
        }
    ]
}
```

### Response
#### Success Response (200)
- **preAnnounchementId** (integer) - The ID of the created pre-announcement.

#### Response Example
```json
{
  "preAnnounchementId": 12345
}
```
```

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

### Manage Goods Receipts (Puts)

Source: https://itsperfect.stoplight.io/docs/itsperfect/m6r83djacm7cl-connect-an-external-warehouse-3-pl

Endpoints for downloading pending puts and marking them as synchronized.

```text
/api/v3/puts?warehouse_id=1&logistic_connector_status=0&includes=lines
```

```json
{
  "document_type": "put",
  "document_id": "250",
  "status": "success",
  "reference": "3920382"
}
```

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

### POST /api/v3/returns

Source: https://itsperfect.stoplight.io/docs/itsperfect/m6r83djacm7cl-connect-an-external-warehouse-3-pl

Registers a new B2C return in the Itsperfect system.

```APIDOC
## POST /api/v3/returns

### Description
Adds a new B2C return to Itsperfect when received.

### Method
POST

### Endpoint
/api/v3/returns

### Parameters
#### Request Body
- **delivery_note.id** (string) - Required - The original pick ID.
- **lines.barcode** (string) - Required - EAN barcode of the item.
- **lines.return_reason_id** (integer) - Required - The reason why the item is returned.
- **lines.quantity** (integer) - Required - The returned quantity.

### Request Example
{
    "status": 1,
    "delivery_note": {"id" : "270"},
    "lines": [
        {
            "barcode": "4273492000056",
            "return_reason_id": 3,
            "quantity": 1
        }
    ]
}
```

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

### Add B2C Returns

Source: https://itsperfect.stoplight.io/docs/itsperfect/m6r83djacm7cl-connect-an-external-warehouse-3-pl

Use this endpoint to register a new B2C return in the system.

```json
{
    "status": 1,
    "delivery_note": {"id" : "270"},
    "lines": [
        {
            "barcode": "4273492000056",
            "return_reason_id": 3,
            "quantity": 1
        },
        {
            "barcode": "4273492000049",
            "return_reason_id": 1,
            "quantity": 1
        }
    ]
}
```

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

### POST /api/v3/sales_return_pre_announcements - Commercial Exchange

Source: https://itsperfect.stoplight.io/docs/itsperfect/ez9isnk87ejgw-connect-a-return-portal

Creates a pre-announcement for a commercial exchange. When creating the pre-announcement, the new exchange order is generated immediately. Once the return is received, the exchange order will be automatically released.

```APIDOC
## POST /api/v3/sales_return_pre_announcements

### Description
Creates a pre-announcement for a commercial exchange. When creating the pre-announcement, the new exchange order is generated immediately. Once the return is received, the exchange order will be automatically released. In the case of an exchange, no refund will be triggered to the webshop.

### Method
POST

### Endpoint
/api/v3/sales_return_pre_announcements

### Parameters
#### Request Body
- **sales_order** (object) - Required - The original sales order in Itsperfect.
  - **id** (integer) - Required - The ID of the sales order.
- **return_number** (string) - Required - The track & trace number created by the return portal.
- **refund_via_giftcard** (integer) - Optional - Indicates if the refund should be processed via a gift card (1 for yes, 0 for no).
- **lines** (array) - Required - An array of exchange lines.
  - **type** (string) - Required - Type of line item, should be 'exchange'.
  - **barcode** (string) - Required - Barcode of the item being returned.
  - **return_reason_id** (integer) - Required - The ID of the return reason.
  - **quantity** (integer) - Required - The quantity of the item being returned.
  - **exchange** (object) - Required - Details for the exchange item.
    - **barcode** (string) - Required - Barcode of the item to be exchanged.
    - **item_id** (integer) - Required - The ID of the item.
    - **color_id** (integer) - Required - The ID of the color.
    - **size_id** (integer) - Required - The ID of the size.

### Request Example
```json
{
    "sales_order": {"id" : 1350},
    "return_number": "3SABCD123456789",
    "refund_via_giftcard": 1,
    "lines": [
        {
            "type": "exchange",
            "barcode": "4273492000001",
            "return_reason_id": 4,
            "quantity": 1,
            "exchange": {
                "barcode": "4273492000124",
                "item_id": 44,
                "color_id": 4,
                "size_id": 17
            }
        }
    ]
}
```

### Response
#### Success Response (200)
- **preAnnounchementId** (integer) - The ID of the created pre-announcement.

#### Response Example
```json
{
  "preAnnounchementId": 12345
}
```
```

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

### POST /api/v3/puts/{id}/receive

Source: https://itsperfect.stoplight.io/docs/itsperfect/m6r83djacm7cl-connect-an-external-warehouse-3-pl

Record the receipt of goods or boxes in Itsperfect.

```APIDOC
## POST /api/v3/puts/{id}/receive

### Description
Record the receipt of goods or full boxes in Itsperfect for a specific put ID.

### Method
POST

### Endpoint
/api/v3/puts/{id}/receive

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the put document.

### Request Example
{
    "status": "received",
    "lines": [
        {
            "barcode": "4273492000001",
            "quantity": 1
        }
    ]
}
```

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

### Retrieve Items and Updates

Source: https://itsperfect.stoplight.io/docs/itsperfect/m6r83djacm7cl-connect-an-external-warehouse-3-pl

Endpoints for fetching all items or only those updated since a specific timestamp.

```text
/api/v3/items?includes=barcodes
```

```text
/api/v3/items?includes=barcodes&last_update_timestamp>2025-03-10 15:07:35
```

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

### Platform API Overview

Source: https://itsperfect.stoplight.io/docs/itsperfect/944fcc90d7052-platform-api

The Itsperfect Platform API provides structured access to ERP data including items, sales orders, inventory, and connector configurations.

```APIDOC
## Platform API Overview

### Description
The Itsperfect Platform API allows for programmatic interaction with ERP resources. It supports operations across various modules including items, sales, logistics, and financial connectors.

### Authentication
Authentication is required for all API requests. Please refer to the Authentication section in the documentation for details on obtaining and using access tokens.

### Rate Limits
API usage is subject to rate limits to ensure platform stability. Consult the Rate limits section for specific thresholds.

### Key Modules
- **Items**: Manage product data, colors, sizes, barcodes, stock, and pricing.
- **Sales**: Manage sales orders, returns, invoices, and payments.
- **Logistics**: Manage purchase orders, transit orders, picks, and boxes.
- **Connectors**: Integration endpoints for webshops, logistics (3PL), and financial systems.
```

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

### Rate Limiting Mechanism

Source: https://itsperfect.stoplight.io/docs/itsperfect/xxwvu1j3kqriq-rate-limits

Explanation of how the rate limiting works, including request processing and limit enforcement.

```APIDOC
## Rate Limiting Mechanism

### Description
This API uses a rate-limiting mechanism based on the "leaky bucket" principle. Each request adds a 'marble' to the bucket. Once the bucket is full, requests are restricted until a marble is removed. A marble is removed from the bucket every 4 seconds.

### Behavior on Limit Exceeded
When the rate limit is reached, the server may respond with a `429 Too Many Requests` status code. The response headers will indicate when new requests can be made.

### Example Success Response with Headers
```http
HTTP/1.1 200 OK
X-Bucket-Size: 100
X-Marbles-In-Bucket: 75
X-Remaining-Requests: 25
Content-Type: application/json
```

### Example Error Response (429)
```http
HTTP/1.1 429 Too Many Requests
X-Bucket-Size: 100
X-Marbles-In-Bucket: 100
X-Remaining-Requests: 0
Retry-After: 4
Content-Type: application/json

{
  "error": "Rate limit exceeded. Please try again later."
}
```
```

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

### Ship Crossdocking Orders

Source: https://itsperfect.stoplight.io/docs/itsperfect/m6r83djacm7cl-connect-an-external-warehouse-3-pl

Use this endpoint to ship full boxes in a box management pick scenario.

```json
{
    "status": "shipped",
    "lines": [
        {
            "box": {
                "barcode": "1046-458"
            }
        },
        {
            "box": {
                "barcode": "1047-461"
            }
        }
    ]
}
```

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

### Rate Limiting Headers

Source: https://itsperfect.stoplight.io/docs/itsperfect/xxwvu1j3kqriq-rate-limits

These headers are returned with each API request to provide information about the current rate limits and your remaining capacity.

```APIDOC
## Rate Limiting Headers

### Description
These headers provide insight into the API's rate-limiting mechanism, based on the leaky bucket principle.

### Headers

- **X-Bucket-Size** (integer) - The maximum capacity of the rate limit bucket.
- **X-Marbles-In-Bucket** (integer) - The current number of requests (marbles) in the bucket.
- **X-Remaining-Requests** (integer) - The number of requests that can still be made before hitting the limit.

### Example Response Headers
```
X-Bucket-Size: 100
X-Marbles-In-Bucket: 75
X-Remaining-Requests: 25
```
```

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

### POST /api/v3/logistic_connector

Source: https://itsperfect.stoplight.io/docs/itsperfect/m6r83djacm7cl-connect-an-external-warehouse-3-pl

Mark a document (put or pick) as successfully synchronized.

```APIDOC
## POST /api/v3/logistic_connector

### Description
Mark a put or pick document as successfully synchronized in the system.

### Method
POST

### Endpoint
/api/v3/logistic_connector

### Parameters
#### Request Body
- **document_type** (string) - Required - Type of document ('put' or 'pick').
- **document_id** (string) - Required - The ID of the document.
- **status** (string) - Required - Status of the operation (e.g., 'success').
- **reference** (string) - Required - The number of the receipt/delivery in the logistic system.

### Request Example
{
  "document_type": "put",
  "document_id": "250",
  "status": "success",
  "reference": "3920382"
}
```

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

### POST /api/v3/logistic_connector

Source: https://itsperfect.stoplight.io/docs/itsperfect/m6r83djacm7cl-connect-an-external-warehouse-3-pl

Reports an error that occurred while downloading a put or pick document to the Itsperfect user.

```APIDOC
## POST /api/v3/logistic_connector

### Description
Informs the Itsperfect user about an error that occurred while downloading a put or pick document.

### Method
POST

### Endpoint
/api/v3/logistic_connector

### Parameters
#### Request Body
- **document_type** (string) - Required - The type of document, either 'put' or 'pick'.
- **document_id** (string) - Required - The ID of the put or pick document.
- **status** (string) - Required - The status of the operation, should be 'error'.
- **error_message** (string) - Required - The description of the error encountered.

### Request Example
{
  "document_type": "pick",
  "document_id": "270",
  "status": "error",
  "error_message": "Error message"
}
```

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

### Receive Goods in Itsperfect

Source: https://itsperfect.stoplight.io/docs/itsperfect/m6r83djacm7cl-connect-an-external-warehouse-3-pl

Payloads for recording received goods or full boxes against a put ID.

```json
{
    "status": "received",
    "lines": [
        {
            "barcode": "4273492000001",
            "quantity": 1
        },
        {
            "barcode": "4273492000018",
            "quantity": 2
        }
    ]
}
```

```json
{
    "status": "received",
    "lines": [
        {
            "box": {
                "barcode": "1046-458"
            }
        },
        {
            "box": {
                "barcode": "1047-461"
            }
        }
    ]
}
```

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

### POST /api/v3/picks/{id}/ship

Source: https://itsperfect.stoplight.io/docs/itsperfect/m6r83djacm7cl-connect-an-external-warehouse-3-pl

Records a shipment for a pick or updates the status to collected. Also supports shipping full boxes for crossdocking orders.

```APIDOC
## POST /api/v3/picks/{id}/ship

### Description
Records the shipment of goods from the warehouse. Can also be used to set the status to 'collected' or ship full boxes for crossdocking.

### Method
POST

### Endpoint
/api/v3/picks/{id}/ship

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the pick.

### Request Example
{
    "status": "shipped",
    "return_number": "3s39203823073234",
    "dispatch_partner": {"dispatch_partner": "DHL"},
    "lines": [
        {
            "barcode": "4273492000049",
            "quantity": 1,
            "box": {
                "barcode": "8001",
                "dispatch_number": "3s39203823073234",
                "reference": "GR392-1",
                "sscc": "AAA-001"
            }
        }
    ]
}
```

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

### Record Shipment in Itsperfect

Source: https://itsperfect.stoplight.io/docs/itsperfect/m6r83djacm7cl-connect-an-external-warehouse-3-pl

Use this endpoint to record a shipment after goods have left the warehouse. The status can be set to 'shipped' or 'collected'.

```json
{
    "status": "shipped",
    "return_number": "3s39203823073234",
    "dispatch_partner": {"dispatch_partner": "DHL"},
    "lines": [
        {
            "barcode": "4273492000049",
            "quantity": 1,
            "box": {
                "barcode": "8001",
                "dispatch_number": "3s39203823073234",
                "reference": "GR392-1",
                "sscc": "AAA-001"
            }
        },
        {
            "barcode": "4273492000001",
            "quantity": 2,
            "box": {
                "barcode": "8002",
                "dispatch_number": "3s39203823073235",
                "reference": "GR392-2",
                "sscc": "AAA-002"
            }
        },
        {
            "barcode": "4273492000001",
            "quantity": 2,
            "box": {
                "barcode": "8003",
                "dispatch_number": "3s39203823073236",
                "reference": "GR392-3",
                "sscc": "AAA-003"
            }
        }
    ]
}
```

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

### Filter Warehouses by ID

Source: https://itsperfect.stoplight.io/docs/itsperfect/m6r83djacm7cl-connect-an-external-warehouse-3-pl

Use these query parameters to filter warehouse synchronization requests for single or multiple warehouses.

```text
?warehouse_id=1
```

```text
?warehouse_id IN (1,2)
```

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

### Report Download Error

Source: https://itsperfect.stoplight.io/docs/itsperfect/m6r83djacm7cl-connect-an-external-warehouse-3-pl

Use this JSON payload to inform the Itsperfect user about an error during a put or pick operation. Ensure the 'document_type', 'document_id', and 'error_message' fields are correctly populated.

```json
{
  "document_type": "pick",
  "document_id": "270",
  "status": "error",
  "error_message": "Error message"
}
```
Tokens:
Raw